HookSniffAPI.Api.Embed (hooksniff v1.0.0)

API calls for all endpoints tagged Embed.

Summary

Functions

embed_get(connection, opts \\ [])

Embeddable portal HTML

embed_script_get(connection, opts \\ [])

Embeddable portal JavaScript

Functions

embed_get(connection, opts \\ [])

@spec embed_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Embeddable portal HTML

Parameters

  • connection (HookSniffAPI.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

embed_script_get(connection, opts \\ [])

@spec embed_script_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Embeddable portal JavaScript

Parameters

  • connection (HookSniffAPI.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure