ChatKittyPlatformAPI.Api.UserSessions (chatkitty_platform_sdk v0.1.0)
API calls for all endpoints tagged UserSessions
.
Link to this section Summary
Functions
List user sessions Returns a page of user sessions belonging to this application
Link to this section Functions
Link to this function
list_user_sessions(connection, opts \\ [])
@spec list_user_sessions( Tesla.Env.client(), keyword() ) :: {:ok, ChatKittyPlatformAPI.Model.ApiError.t()} | {:ok, ChatKittyPlatformAPI.Model.PagedModelChatUserSessionResource.t()} | {:ok, ChatKittyPlatformAPI.Model.AuthenticationError.t()} | {:error, Tesla.Env.t()}
List user sessions Returns a page of user sessions belonging to this application
parameters
Parameters
- connection (ChatKittyPlatformAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :page (integer()): Zero-based page index (0..N)
- :size (integer()): The size of the page to be returned
- :sort ([String.t]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
- :state (String.t): Filters by state
returns
Returns
on success {:error, Tesla.Env.t} on failure