Package com.symphony.bdk.gen.api

Class PresenceApi

java.lang.Object
com.symphony.bdk.gen.api.PresenceApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-03-26T16:14:56.804588655Z[Etc/UTC]") public class PresenceApi extends Object

  • Constructor Details

    • PresenceApi

      public PresenceApi(com.symphony.bdk.http.api.ApiClient apiClient)

  • Method Details

    • getApiClient

      public com.symphony.bdk.http.api.ApiClient getApiClient()
      Get the API cilent
      Returns:
      API client

    • setApiClient

      public void setApiClient(com.symphony.bdk.http.api.ApiClient apiClient)
      Set the API cilent
      Parameters:
      apiClient - an instance of API client

    • v1PresenceFeedCreatePost

      public StringId v1PresenceFeedCreatePost(String sessionToken) throws com.symphony.bdk.http.api.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:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1PresenceFeedCreatePostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<StringId> v1PresenceFeedCreatePostWithHttpInfo(String sessionToken) throws com.symphony.bdk.http.api.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:
      ApiResponse<StringId>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1PresenceFeedFeedIdDeletePost

      public StringId v1PresenceFeedFeedIdDeletePost(String sessionToken, String feedId) throws com.symphony.bdk.http.api.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:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1PresenceFeedFeedIdDeletePostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<StringId> v1PresenceFeedFeedIdDeletePostWithHttpInfo(String sessionToken, String feedId) throws com.symphony.bdk.http.api.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:
      ApiResponse<StringId>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1PresenceFeedFeedIdReadGet

      public List<V2Presence> v1PresenceFeedFeedIdReadGet(String sessionToken, String feedId) throws com.symphony.bdk.http.api.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:
      List<V2Presence>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1PresenceFeedFeedIdReadGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<List<V2Presence>> v1PresenceFeedFeedIdReadGetWithHttpInfo(String sessionToken, String feedId) throws com.symphony.bdk.http.api.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:
      ApiResponse<List<V2Presence>>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1UserPresenceGet

      @Deprecated public Presence v1UserPresenceGet(String sessionToken) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      Get presence information about the requesting user.
      Parameters:
      sessionToken - Session authentication token. (required)
      Returns:
      Presence
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1UserPresenceGetWithHttpInfo

      @Deprecated public com.symphony.bdk.http.api.ApiResponse<Presence> v1UserPresenceGetWithHttpInfo(String sessionToken) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      Get presence information about the requesting user.
      Parameters:
      sessionToken - Session authentication token. (required)
      Returns:
      ApiResponse<Presence>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1UserPresencePost

      @Deprecated public Presence v1UserPresencePost(String sessionToken, Presence presence) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      Set the presence of the requesting user.
      Parameters:
      sessionToken - Session authentication token. (required)
      presence - (required)
      Returns:
      Presence
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1UserPresencePostWithHttpInfo

      @Deprecated public com.symphony.bdk.http.api.ApiResponse<Presence> v1UserPresencePostWithHttpInfo(String sessionToken, Presence presence) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      Set the presence of the requesting user.
      Parameters:
      sessionToken - Session authentication token. (required)
      presence - (required)
      Returns:
      ApiResponse<Presence>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1UserPresenceRegisterPost

      public SuccessResponse v1UserPresenceRegisterPost(String sessionToken, List<Long> uidList) throws com.symphony.bdk.http.api.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:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1UserPresenceRegisterPostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1UserPresenceRegisterPostWithHttpInfo(String sessionToken, List<Long> uidList) throws com.symphony.bdk.http.api.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:
      ApiResponse<SuccessResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1UserUidPresenceGet

      @Deprecated public Presence v1UserUidPresenceGet(Long uid, String sessionToken) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      Get presence information about a particular user.
      Parameters:
      uid - User ID as a decimal integer (required)
      sessionToken - Session authentication token. (required)
      Returns:
      Presence
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1UserUidPresenceGetWithHttpInfo

      @Deprecated public com.symphony.bdk.http.api.ApiResponse<Presence> v1UserUidPresenceGetWithHttpInfo(Long uid, String sessionToken) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      Get presence information about a particular user.
      Parameters:
      uid - User ID as a decimal integer (required)
      sessionToken - Session authentication token. (required)
      Returns:
      ApiResponse<Presence>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1UserUidPresencePost

      @Deprecated public Presence v1UserUidPresencePost(Long uid, String sessionToken, Presence presence) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      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:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1UserUidPresencePostWithHttpInfo

      @Deprecated public com.symphony.bdk.http.api.ApiResponse<Presence> v1UserUidPresencePostWithHttpInfo(Long uid, String sessionToken, Presence presence) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      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:
      ApiResponse<Presence>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v2UserPresenceGet

      public V2Presence v2UserPresenceGet(String sessionToken) throws com.symphony.bdk.http.api.ApiException
      Get presence information about the requesting user.
      Parameters:
      sessionToken - Session authentication token. (required)
      Returns:
      V2Presence
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v2UserPresenceGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<V2Presence> v2UserPresenceGetWithHttpInfo(String sessionToken) throws com.symphony.bdk.http.api.ApiException
      Get presence information about the requesting user.
      Parameters:
      sessionToken - Session authentication token. (required)
      Returns:
      ApiResponse<V2Presence>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v2UserPresencePost

      public V2Presence v2UserPresencePost(String sessionToken, V2PresenceStatus presence, Boolean soft) throws com.symphony.bdk.http.api.ApiException
      Set the presence of the requesting user.
      Parameters:
      sessionToken - Session authentication token. (required)
      presence - (required)
      soft - If true, the user's current status is taken into consideration. If the user is currently OFFLINE, the user's presence will still be OFFLINE, but the new presence will take effect when the user comes online. If the user is currently online, the user's activity state will be applied to the presence if applicable. (e.g. if you are setting their presence to AVAILABLE, but the user is currently idle, their status will be represented as AWAY) (optional)
      Returns:
      V2Presence
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v2UserPresencePostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<V2Presence> v2UserPresencePostWithHttpInfo(String sessionToken, V2PresenceStatus presence, Boolean soft) throws com.symphony.bdk.http.api.ApiException
      Set the presence of the requesting user.
      Parameters:
      sessionToken - Session authentication token. (required)
      presence - (required)
      soft - If true, the user's current status is taken into consideration. If the user is currently OFFLINE, the user's presence will still be OFFLINE, but the new presence will take effect when the user comes online. If the user is currently online, the user's activity state will be applied to the presence if applicable. (e.g. if you are setting their presence to AVAILABLE, but the user is currently idle, their status will be represented as AWAY) (optional)
      Returns:
      ApiResponse<V2Presence>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v2UserUidPresenceGet

      @Deprecated public Presence v2UserUidPresenceGet(Long uid, String sessionToken, Boolean local) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      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:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v2UserUidPresenceGetWithHttpInfo

      @Deprecated public com.symphony.bdk.http.api.ApiResponse<Presence> v2UserUidPresenceGetWithHttpInfo(Long uid, String sessionToken, Boolean local) throws com.symphony.bdk.http.api.ApiException
      Deprecated.
      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:
      ApiResponse<Presence>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v2UsersPresenceGet

      public List<V2Presence> v2UsersPresenceGet(String sessionToken, Long lastUserId, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get presence information about all company (pod) users. The returned data is taken from the in-memory cache for performance reasons which means inactive users may be omitted from the response. All non-inactive users WILL be returned and some inactive users MAY be included. Any omitted user IS inactive. Returned records are sorted by user ID, ascending. This method is expensive. It pulls ALL records from the cache, sorts them and then only uses a subset. For large numbers of users, this can be very inefficient both due to sorting and due to the cache being distributed across many nodes. Addiionally, there is the potential to miss users if they become active after the page in which their user ID falls has already been read by the client. To avoid this situation, a presence feed should be created (and optionally read from) first to capture presence changes of users who get reactivated during a paged call to this endpoint.
      Parameters:
      sessionToken - Session authentication token. (required)
      lastUserId - Last user ID retrieved. Used for paging; if provided, results will skip users with IDs less than this parameter. (optional)
      limit - Max number of records to return. If no value is provided, 1000 is the default. The maximum supported value is 5000. (optional)
      Returns:
      List<V2Presence>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v2UsersPresenceGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<List<V2Presence>> v2UsersPresenceGetWithHttpInfo(String sessionToken, Long lastUserId, Integer limit) throws com.symphony.bdk.http.api.ApiException
      Get presence information about all company (pod) users. The returned data is taken from the in-memory cache for performance reasons which means inactive users may be omitted from the response. All non-inactive users WILL be returned and some inactive users MAY be included. Any omitted user IS inactive. Returned records are sorted by user ID, ascending. This method is expensive. It pulls ALL records from the cache, sorts them and then only uses a subset. For large numbers of users, this can be very inefficient both due to sorting and due to the cache being distributed across many nodes. Addiionally, there is the potential to miss users if they become active after the page in which their user ID falls has already been read by the client. To avoid this situation, a presence feed should be created (and optionally read from) first to capture presence changes of users who get reactivated during a paged call to this endpoint.
      Parameters:
      sessionToken - Session authentication token. (required)
      lastUserId - Last user ID retrieved. Used for paging; if provided, results will skip users with IDs less than this parameter. (optional)
      limit - Max number of records to return. If no value is provided, 1000 is the default. The maximum supported value is 5000. (optional)
      Returns:
      ApiResponse<List<V2Presence>>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v3UserPresencePost

      public V2Presence v3UserPresencePost(String sessionToken, V2UserPresence presence, Boolean soft) throws com.symphony.bdk.http.api.ApiException
      Set presence information for a particular user.
      Parameters:
      sessionToken - Session authentication token. (required)
      presence - (required)
      soft - If true, the user's current status is taken into consideration. If the user is currently OFFLINE, the user's presence will still be OFFLINE, but the new presence will take effect when the user comes online. If the user is currently online, the user's activity state will be applied to the presence if applicable. (e.g. if you are setting their presence to AVAILABLE, but the user is currently idle, their status will be represented as AWAY) (optional)
      Returns:
      V2Presence
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v3UserPresencePostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<V2Presence> v3UserPresencePostWithHttpInfo(String sessionToken, V2UserPresence presence, Boolean soft) throws com.symphony.bdk.http.api.ApiException
      Set presence information for a particular user.
      Parameters:
      sessionToken - Session authentication token. (required)
      presence - (required)
      soft - If true, the user's current status is taken into consideration. If the user is currently OFFLINE, the user's presence will still be OFFLINE, but the new presence will take effect when the user comes online. If the user is currently online, the user's activity state will be applied to the presence if applicable. (e.g. if you are setting their presence to AVAILABLE, but the user is currently idle, their status will be represented as AWAY) (optional)
      Returns:
      ApiResponse<V2Presence>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v3UserUidPresenceGet

      public V2Presence v3UserUidPresenceGet(Long uid, String sessionToken, Boolean local) throws com.symphony.bdk.http.api.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:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v3UserUidPresenceGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<V2Presence> v3UserUidPresenceGetWithHttpInfo(Long uid, String sessionToken, Boolean local) throws com.symphony.bdk.http.api.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:
      ApiResponse<V2Presence>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call