ExStreamClient.Operations.Users (ExStreamClient v0.1.3)
View SourceModules for interacting with the users
group of Stream APIs
API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2
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
@spec block_users(ExStreamClient.Model.BlockUsersRequest.t(), [{:client, module()}]) :: {:ok, ExStreamClient.Model.BlockUsersResponse.t()} | {:error, any()}
Block users
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec deactivate_user(String.t(), ExStreamClient.Model.DeactivateUserRequest.t(), [ {:client, module()} ]) :: {:ok, ExStreamClient.Model.DeactivateUserResponse.t()} | {:error, any()}
Deactivates user with possibility to activate it back
Sends events:
user.deactivated
Required Arguments:
user_id
payload
:Elixir.ExStreamClient.Model.DeactivateUserRequest
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec deactivate_users(ExStreamClient.Model.DeactivateUsersRequest.t(), [ {:client, module()} ]) :: {:ok, ExStreamClient.Model.DeactivateUsersResponse.t()} | {:error, any()}
Deactivate users in batches
Sends events:
user.deactivated
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec delete_users(ExStreamClient.Model.DeleteUsersRequest.t(), [{:client, module()}]) :: {:ok, ExStreamClient.Model.DeleteUsersResponse.t()} | {:error, any()}
Deletes users and optionally all their belongings asynchronously.
Sends events:
channel.deleted
user.deleted
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec export_user(String.t(), [{:client, module()}]) :: {:ok, ExStreamClient.Model.ExportUserResponse.t()} | {:error, any()}
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
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec get_blocked_users(client: module(), user_id: String.t()) :: {:ok, ExStreamClient.Model.GetBlockedUsersResponse.t()} | {:error, any()}
Get list of blocked Users
Optional Arguments:
user_id
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec query_users( client: module(), payload: ExStreamClient.Model.QueryUsersPayload.t() ) :: {:ok, ExStreamClient.Model.QueryUsersResponse.t()} | {:error, any()}
Find and filter users
Optional Arguments:
payload
:Elixir.ExStreamClient.Model.QueryUsersPayload
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec reactivate_user(String.t(), ExStreamClient.Model.ReactivateUserRequest.t(), [ {:client, module()} ]) :: {:ok, ExStreamClient.Model.ReactivateUserResponse.t()} | {:error, any()}
Activates user who's been deactivated previously
Sends events:
user.reactivated
Required Arguments:
user_id
payload
:Elixir.ExStreamClient.Model.ReactivateUserRequest
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec reactivate_users(ExStreamClient.Model.ReactivateUsersRequest.t(), [ {:client, module()} ]) :: {:ok, ExStreamClient.Model.ReactivateUsersResponse.t()} | {:error, any()}
Reactivate users in batches
Sends events:
user.reactivated
user.reactivated
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec restore_users(ExStreamClient.Model.RestoreUsersRequest.t(), [ {:client, module()} ]) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Restore soft deleted users
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec unblock_users(ExStreamClient.Model.UnblockUsersRequest.t(), [ {:client, module()} ]) :: {:ok, ExStreamClient.Model.UnblockUsersResponse.t()} | {:error, any()}
Unblock users
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec update_users(ExStreamClient.Model.UpdateUsersRequest.t(), [{:client, module()}]) :: {:ok, ExStreamClient.Model.UpdateUsersResponse.t()} | {:error, any()}
Update or create users in bulk
Sends events:
user.updated
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec update_users_partial(ExStreamClient.Model.UpdateUsersPartialRequest.t(), [ {:client, module()} ]) :: {:ok, ExStreamClient.Model.UpdateUsersResponse.t()} | {:error, any()}
Updates certain fields of the user
Sends events:
user.presence.changed
user.updated
user.presence.changed
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)