Spatio.Api.Keybindings (spatio_sdk v0.0.2)

API calls for all endpoints tagged Keybindings.

Summary

Functions

delete_key_binding(connection, id, opts \\ [])

Reset a binding to its platform default.

get_default_key_bindings(connection, opts \\ [])

Platform default key bindings (no user customizations applied).

list_key_bindings(connection, opts \\ [])

User's merged key bindings (defaults + customizations).

reset_all_key_bindings(connection, opts \\ [])

Reset every customization to its platform default.

update_key_binding(connection, id, update_key_binding_request, opts \\ [])

Create or update a user key-binding customization.

validate_key_binding(connection, validate_key_binding_request, opts \\ [])

Check whether a proposed binding conflicts with existing ones.

Functions

delete_key_binding(connection, id, opts \\ [])

@spec delete_key_binding(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Spatio.Model.ApiError.t()} | {:error, Tesla.Env.t()}

Reset a binding to its platform default.

Parameters

connection (Spatio.Connection): Connection to server
id (String.t):
opts (keyword): Optional parameters

Returns

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

get_default_key_bindings(connection, opts \\ [])

@spec get_default_key_bindings(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Spatio.Model.KeyBindingListResponse.t()}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Platform default key bindings (no user customizations applied).

Parameters

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

Returns

{:ok, Spatio.Model.KeyBindingListResponse.t} on success
{:error, Tesla.Env.t} on failure

list_key_bindings(connection, opts \\ [])

@spec list_key_bindings(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Spatio.Model.KeyBindingListResponse.t()}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

User's merged key bindings (defaults + customizations).

Parameters

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

Returns

{:ok, Spatio.Model.KeyBindingListResponse.t} on success
{:error, Tesla.Env.t} on failure

reset_all_key_bindings(connection, opts \\ [])

@spec reset_all_key_bindings(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:ok, Spatio.Model.ApiError.t()} | {:error, Tesla.Env.t()}

Reset every customization to its platform default.

Parameters

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

Returns

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

update_key_binding(connection, id, update_key_binding_request, opts \\ [])

@spec update_key_binding(
  Tesla.Env.client(),
  String.t(),
  Spatio.Model.UpdateKeyBindingRequest.t(),
  keyword()
) ::
  {:ok, Spatio.Model.KeyBinding.t()}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Create or update a user key-binding customization.

Parameters

connection (Spatio.Connection): Connection to server
id (String.t):
update_key_binding_request (UpdateKeyBindingRequest):
opts (keyword): Optional parameters

Returns

{:ok, Spatio.Model.KeyBinding.t} on success
{:error, Tesla.Env.t} on failure

validate_key_binding(connection, validate_key_binding_request, opts \\ [])

@spec validate_key_binding(
  Tesla.Env.client(),
  Spatio.Model.ValidateKeyBindingRequest.t(),
  keyword()
) ::
  {:ok, Spatio.Model.ValidateKeyBindingResponse.t()}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Check whether a proposed binding conflicts with existing ones.

Parameters

connection (Spatio.Connection): Connection to server
validate_key_binding_request (ValidateKeyBindingRequest):
opts (keyword): Optional parameters

Returns

{:ok, Spatio.Model.ValidateKeyBindingResponse.t} on success
{:error, Tesla.Env.t} on failure