ExStreamClient.Operations.Roles (ExStreamClient v0.1.3)
View SourceModules for interacting with the roles
group of Stream APIs
API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2
Summary
Functions
@spec create_role(ExStreamClient.Model.CreateRoleRequest.t(), [{:client, module()}]) :: {:ok, ExStreamClient.Model.CreateRoleResponse.t()} | {:error, any()}
Creates custom role
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec delete_role(String.t(), [{:client, module()}]) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Deletes custom role
Required Arguments:
name
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec list_roles([{:client, module()}]) :: {:ok, ExStreamClient.Model.ListRolesResponse.t()} | {:error, any()}
Lists all available roles
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)