ExStreamClient.Operations.Roles (ExStreamClient v0.1.7)

View Source

Modules for interacting with the roles 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 used
  • api_key_secret - API key secret to use. If not provided, the default secret from config will be used
  • endpoint - endpoint to use. If not provided, the default endpoint from config will be used
  • client - HTTP client to use. Must implement ExStreamClient.Http.Behavior. Defaults to ExStreamClient.Http
  • req_opts - all of these options will be forwarded to req. See Req.new/1 for available options

Summary

Types

shared_opts()

Functions

create_role(payload, opts \\ [])

Creates custom role

delete_role(name, opts \\ [])

Deletes custom role

list_roles(opts \\ [])

Lists all available roles

Types

shared_opts()

@type shared_opts() :: [
  api_key: String.t(),
  api_key_secret: String.t(),
  client: module(),
  endpoint: String.t(),
  req_opts: keyword()
]

Functions

create_role(payload, opts \\ [])

@spec create_role(ExStreamClient.Model.CreateRoleRequest.t(), shared_opts()) ::
  {:ok, ExStreamClient.Model.CreateRoleResponse.t()} | {:error, any()}

Creates custom role

Required Arguments:

Optional Arguments:

delete_role(name, opts \\ [])

@spec delete_role(String.t(), shared_opts()) ::
  {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}

Deletes custom role

Required Arguments:

  • name

Optional Arguments:

list_roles(opts \\ [])

@spec list_roles(shared_opts()) ::
  {:ok, ExStreamClient.Model.ListRolesResponse.t()} | {:error, any()}

Lists all available roles

Optional Arguments: