org.symphonyoss.symphony.pod.api

Class PresenceApi

java.lang.Object

org.symphonyoss.symphony.pod.api.PresenceApi

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-12-17T23:29:05.070-05:00")
public class PresenceApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PresenceApi()
PresenceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
StringId	v1PresenceFeedCreatePost(String sessionToken) Create Presence status feed.
StringId	v1PresenceFeedFeedIdDeletePost(String sessionToken, String feedId) Delete a presence status feed.
V2PresenceList	v1PresenceFeedFeedIdReadGet(String sessionToken, String feedId) Read a presence status feed.
Presence	v1UserPresenceGet(String sessionToken) Get presence information about the requesting user.
Presence	v1UserPresencePost(String sessionToken, Presence presence) Set the presence of the requesting user.
SuccessResponse	v1UserPresenceRegisterPost(String sessionToken, UserIdList uidList) Register interest in a user's presence status
Presence	v1UserUidPresenceGet(Long uid, String sessionToken) Get presence information about a particular user.
Presence	v1UserUidPresencePost(Long uid, String sessionToken, Presence presence) LIMITED RELEASE Set presence information for a particular user.
V2Presence	v2UserPresenceGet(String sessionToken) Get presence information about the requesting user.
V2Presence	v2UserPresencePost(String sessionToken, V2PresenceStatus presence) Set the presence of the requesting user.
Presence	v2UserUidPresenceGet(Long uid, String sessionToken, Boolean local) Get presence information about a particular user.
V2Presence	v3UserUidPresenceGet(Long uid, String sessionToken, Boolean local) Get presence information about a particular user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PresenceApi

public PresenceApi()

PresenceApi

public PresenceApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

v1PresenceFeedCreatePost

public StringId v1PresenceFeedCreatePost(String sessionToken)
                                  throws ApiException

Create Presence status feed. Create a new stream capturing presence status changes (\"presence feed\"). When read from, the feed will return the current presence status of company (pod) users if it has changed since the last read. Returns the ID of the presence feed to be used in subsequent read operations.

Parameters:

sessionToken - Session authentication token. (required)

Returns:

StringId

Throws:

ApiException - if fails to make API call

v1PresenceFeedFeedIdDeletePost

public StringId v1PresenceFeedFeedIdDeletePost(String sessionToken,
                                               String feedId)
                                        throws ApiException

Delete a presence status feed. Returns the ID of the deleted feed.

Parameters:

sessionToken - Session authentication token. (required)

feedId - Presence feed ID. (required)

Returns:

StringId

Throws:

ApiException - if fails to make API call

v1PresenceFeedFeedIdReadGet

public V2PresenceList v1PresenceFeedFeedIdReadGet(String sessionToken,
                                                  String feedId)
                                           throws ApiException

Read a presence status feed. Returns the current presence status of company (pod) users if it has changed since the last read. Returns up to 500 records at a time.

Parameters:

sessionToken - Session authentication token. (required)

feedId - Presence feed ID. (required)

Returns:

V2PresenceList

Throws:

ApiException - if fails to make API call

v1UserPresenceGet

public Presence v1UserPresenceGet(String sessionToken)
                           throws ApiException

Get presence information about the requesting user.

Parameters:

sessionToken - Session authentication token. (required)

Returns:

Presence

Throws:

ApiException - if fails to make API call

v1UserPresencePost

public Presence v1UserPresencePost(String sessionToken,
                                   Presence presence)
                            throws ApiException

Set the presence of the requesting user.

Parameters:

sessionToken - Session authentication token. (required)

presence - (required)

Returns:

Presence

Throws:

ApiException - if fails to make API call

v1UserPresenceRegisterPost

public SuccessResponse v1UserPresenceRegisterPost(String sessionToken,
                                                  UserIdList uidList)
                                           throws ApiException

Register interest in a user's presence status

Parameters:

sessionToken - Session authentication token. (required)

uidList - List of (integer) User IDs of users whose presence to query (required)

Returns:

SuccessResponse

Throws:

ApiException - if fails to make API call

v1UserUidPresenceGet

public Presence v1UserUidPresenceGet(Long uid,
                                     String sessionToken)
                              throws ApiException

Get presence information about a particular user.

Parameters:

uid - User ID as a decimal integer (required)

sessionToken - Session authentication token. (required)

Returns:

Presence

Throws:

ApiException - if fails to make API call

v1UserUidPresencePost

public Presence v1UserUidPresencePost(Long uid,
                                      String sessionToken,
                                      Presence presence)
                               throws ApiException

LIMITED RELEASE Set presence information for a particular user. Only the following states can be set AVAILABLE BUSY ON_THE_PHONE AWAY Attempts to set other states will result in a 403 FORBIDDEN response. The UNDEFINED value is an error case used to represent the case if the value stored in the system cannot be represented by the values known to the API. The other states are reserved for future use.

Parameters:

uid - User ID as a decimal integer (required)

sessionToken - Session authentication token. (required)

presence - (required)

Returns:

Presence

Throws:

ApiException - if fails to make API call

v2UserPresenceGet

public V2Presence v2UserPresenceGet(String sessionToken)
                             throws ApiException

Get presence information about the requesting user.

Parameters:

sessionToken - Session authentication token. (required)

Returns:

V2Presence

Throws:

ApiException - if fails to make API call

v2UserPresencePost

public V2Presence v2UserPresencePost(String sessionToken,
                                     V2PresenceStatus presence)
                              throws ApiException

Set the presence of the requesting user.

Parameters:

sessionToken - Session authentication token. (required)

presence - (required)

Returns:

V2Presence

Throws:

ApiException - if fails to make API call

v2UserUidPresenceGet

public Presence v2UserUidPresenceGet(Long uid,
                                     String sessionToken,
                                     Boolean local)
                              throws ApiException

Get presence information about a particular user.

Parameters:

uid - User ID as a decimal integer (required)

sessionToken - Session authentication token. (required)

local - If true, a local query will be performed and the presence will be set to OFFLINE for users who are not local to the calling user's pod. If false or absent, then the presence of all local users and the presence of all external users to whom the calling user is connected will be queried. For external users, a \"presence interest\" should be registered through /v1/user/presence/register before querying for presence. (optional, default to false)

Returns:

Presence

Throws:

ApiException - if fails to make API call

v3UserUidPresenceGet

public V2Presence v3UserUidPresenceGet(Long uid,
                                       String sessionToken,
                                       Boolean local)
                                throws ApiException

Get presence information about a particular user.

Parameters:

uid - User ID as a decimal integer (required)

sessionToken - Session authentication token. (required)

local - If true, a local query will be performed and the presence will be set to OFFLINE for users who are not local to the calling user's pod. If false or absent, then the presence of all local users and the presence of all external users to whom the calling user is connected will be queried. For external users, a \"presence interest\" should be registered through /v1/user/presence/register before querying for presence. (optional, default to false)

Returns:

V2Presence

Throws:

ApiException - if fails to make API call