ExStreamClient.Operations.Users (ExStreamClient v0.1.5)
View SourceModules for interacting with the users
group of Stream APIs
API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2
Shared options
All functions in this module accept the following optional parameters:
api_key
- API key to use. If not provided, the default key from config will be usedapi_key_secret
- API key secret to use. If not provided, the default secret from config will be usedendpoint
- endpoint to use. If not provided, the default endpoint from config will be usedclient
- HTTP client to use. Must implementExStreamClient.Http.Behavior
. Defaults toExStreamClient.Http
req_opts
- all of these options will be forwarded to req. SeeReq.new/1
for available options
Summary
Functions
Block users
Deactivates user with possibility to activate it back
Deactivate users in batches
Deletes users and optionally all their belongings asynchronously.
Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions
Get list of blocked Users
Find and filter users
Activates user who's been deactivated previously
Reactivate users in batches
Restore soft deleted users
Unblock users
Update or create users in bulk
Updates certain fields of the user
Functions
Block users
Required Arguments:
All options from Shared Options are supported.
Deactivates user with possibility to activate it back
Sends events:
user.deactivated
Required Arguments:
user_id
payload
:Elixir.ExStreamClient.Model.DeactivateUserRequest
All options from Shared Options are supported.
Deactivate users in batches
Sends events:
user.deactivated
Required Arguments:
All options from Shared Options are supported.
Deletes users and optionally all their belongings asynchronously.
Sends events:
channel.deleted
user.deleted
Required Arguments:
All options from Shared Options are supported.
Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions
Required Arguments:
user_id
All options from Shared Options are supported.
@spec get_blocked_users( req_opts: keyword(), client: module(), endpoint: String.t(), api_key: String.t(), api_key_secret: String.t() ) :: {:ok, ExStreamClient.Model.GetBlockedUsersResponse.t()} | {:error, any()}
Get list of blocked Users
Optional Arguments:
user_id
All options from Shared Options are supported.
@spec query_users( req_opts: keyword(), client: module(), endpoint: String.t(), api_key: String.t(), api_key_secret: String.t() ) :: {:ok, ExStreamClient.Model.QueryUsersResponse.t()} | {:error, any()}
Find and filter users
Optional Arguments:
All options from Shared Options are supported.
Activates user who's been deactivated previously
Sends events:
user.reactivated
Required Arguments:
user_id
payload
:Elixir.ExStreamClient.Model.ReactivateUserRequest
All options from Shared Options are supported.
Reactivate users in batches
Sends events:
user.reactivated
user.reactivated
Required Arguments:
All options from Shared Options are supported.
Restore soft deleted users
Required Arguments:
All options from Shared Options are supported.
Unblock users
Required Arguments:
All options from Shared Options are supported.
Update or create users in bulk
Sends events:
user.updated
Required Arguments:
All options from Shared Options are supported.
Updates certain fields of the user
Sends events:
user.presence.changed
user.updated
user.presence.changed
Required Arguments:
All options from Shared Options are supported.