OSTIP_EXARI

v0.1.0

OSTIP_EXARI v0.1.0 Swagger.Client.Api.ApiDocsapplicationsFormat View Source

API calls for all endpoints tagged ApiDocsapplicationsFormat.

Link to this section Summary

Functions

get(connection, application_name, opts \\ [])

Get details of an application

list(connection, opts \\ [])

List all applications

subscribe(connection, application_name, event_source, opts \\ [])

Subscribe an application to a event source. Returns the state of the application after the subscriptions have changed

unsubscribe(connection, application_name, event_source, opts \\ [])

Unsubscribe an application from an event source. Returns the state of the application after the subscriptions have changed

Link to this section Functions

Link to this function get(connection, application_name, opts \\ []) View Source 
get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Get details of an application.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • application_name (String.t): Application's name
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function list(connection, opts \\ []) View Source 
list(Tesla.Env.client(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}

List all applications.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function subscribe(connection, application_name, event_source, opts \\ []) View Source 
subscribe(Tesla.Env.client(), String.t(), [String.t()], keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Subscribe an application to a event source. Returns the state of the application after the subscriptions have changed

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • application_name (String.t): Application's name
  • event_source ([String.t]): URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function unsubscribe(connection, application_name, event_source, opts \\ []) View Source 
unsubscribe(Tesla.Env.client(), String.t(), [String.t()], keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Unsubscribe an application from an event source. Returns the state of the application after the subscriptions have changed

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • application_name (String.t): Application's name
  • event_source ([String.t]): URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure