ExClubhouse v0.5.1 ExClubhouse.Api.LinkedFile View Source
Linked file API
Link to this section Summary
Functions
Create a LinkedFile
Delete a LinkedFile
Get a single LinkedFile by id
Lists all LinkedFile
Update a LinkedFile
Link to this section Functions
Link to this function
create(linked_file_input)
View Sourcecreate(ExClubhouse.Model.Input.LinkedFile.t()) :: {:ok, ExClubhouse.Model.LinkedFile.t()} | {:error, ExClubhouse.Error.t()}
Create a LinkedFile
Example
iex> ExClubhouse.Api.LinkedFile.create(ExClubhouse.Model.Input.LinkedFile{...})
{:ok, %ExClubhouse.Model.LinkedFile{...}}
Link to this function
create(session, linked_file_input)
View Sourcecreate(ExClubhouse.Session.t(), ExClubhouse.Model.Input.LinkedFile.t()) :: {:ok, ExClubhouse.Model.LinkedFile.t()} | {:error, ExClubhouse.Error.t()}
Link to this function
delete(linked_file_public_id)
View Sourcedelete(integer()) :: :ok | {:error, ExClubhouse.Error.t()}
Delete a LinkedFile
## Example
iex> ExClubhouse.Api.LinkedFile.delete(1)
:ok
Link to this function
delete(session, linked_file_public_id)
View Sourcedelete(ExClubhouse.Session.t(), integer()) :: :ok | {:error, ExClubhouse.Error.t()}
Link to this function
get(linked_file_public_id)
View Sourceget(integer()) :: {:ok, nil | ExClubhouse.Model.LinkedFile.t()} | {:error, ExClubhouse.Error.t()}
Get a single LinkedFile by id
Example
iex> ExClubhouse.Api.LinkedFile.get(1)
{:ok, %ExClubhouse.Model.LinkedFile{...}}
Link to this function
get(session, linked_file_public_id)
View Sourceget(ExClubhouse.Session.t(), integer()) :: {:ok, ExClubhouse.Model.LinkedFile.t() | nil} | {:error, ExClubhouse.Error.t()}
Link to this function
list()
View Sourcelist() :: {:ok, [ExClubhouse.Model.LinkedFile.t()]} | {:error, ExClubhouse.Error.t()}
Lists all LinkedFile
Example
iex> ExClubhouse.Api.LinkedFile.list()
{:ok, [%ExClubhouse.Model.LinkedFile{...}, ...]}
Link to this function
list(sess)
View Sourcelist(ExClubhouse.Session.t()) :: {:ok, [ExClubhouse.Model.LinkedFile.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function
update(linked_file_public_id, linked_file_input)
View Sourceupdate(integer(), ExClubhouse.Model.Input.LinkedFile.t()) :: {:ok, ExClubhouse.Model.LinkedFile.t()} | {:error, ExClubhouse.Error.t()}
Update a LinkedFile
Example
iex> ExClubhouse.Api.LinkedFile.update(1, ExClubhouse.Model.Input.LinkedFile{...})
{:ok, %ExClubhouse.Model.LinkedFile{...}}
Link to this function
update(session, linked_file_public_id, linked_file_input)
View Sourceupdate( ExClubhouse.Session.t(), integer(), ExClubhouse.Model.Input.LinkedFile.t() ) :: {:ok, ExClubhouse.Model.LinkedFile.t()} | {:error, ExClubhouse.Error.t()}