ExStreamClient.Operations.Roles (ExStreamClient v0.1.5)

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

Functions

Creates custom role

Deletes custom role

Lists all available roles

Functions

create_role(payload, opts \\ [])

Creates custom role

Required Arguments:

All options from Shared Options are supported.

delete_role(name, opts \\ [])

Deletes custom role

Required Arguments:

  • name

All options from Shared Options are supported.

list_roles(opts \\ [])

Lists all available roles

All options from Shared Options are supported.