ExStreamClient.Operations.Roles (ExStreamClient v0.1.3)

View Source

Modules for interacting with the roles group of Stream APIs

API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2

Summary

Functions

Creates custom role

Deletes custom role

Lists all available roles

Functions

create_role(payload, opts \\ [])

@spec create_role(ExStreamClient.Model.CreateRoleRequest.t(), [{:client, module()}]) ::
  {:ok, ExStreamClient.Model.CreateRoleResponse.t()} | {:error, any()}

Creates custom role

Required Arguments:

Optional Arguments:

delete_role(name, opts \\ [])

@spec delete_role(String.t(), [{:client, module()}]) ::
  {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}

Deletes custom role

Required Arguments:

  • name

Optional Arguments:

list_roles(opts \\ [])

@spec list_roles([{:client, module()}]) ::
  {:ok, ExStreamClient.Model.ListRolesResponse.t()} | {:error, any()}

Lists all available roles

Optional Arguments: