ExStreamClient.Operations.PushProviders (ExStreamClient v0.1.5)

View Source

Modules for interacting with the push_providers 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

Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint

List details of all push providers.

Upsert a push provider for v2 with multi bundle/package support

Functions

delete_push_provider(type, name, opts \\ [])

Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint

Required Arguments:

  • type
  • name

All options from Shared Options are supported.

list_push_providers(opts \\ [])

List details of all push providers.

All options from Shared Options are supported.

upsert_push_provider(payload, opts \\ [])

Upsert a push provider for v2 with multi bundle/package support

Required Arguments:

All options from Shared Options are supported.