ExClubhouse v0.5.2 ExClubhouse.Api.Story View Source

Story api

Link to this section Summary

Functions

Create a Story

Create a comment within a story

Delete a Story

Get a single Story by id

Link to this section Functions

Create a Story

Example

iex> ExClubhouse.Api.Story.create(ExClubhouse.Model.Input.Story{...})
{:ok, %ExClubhouse.Model.Story{...}}
Link to this function

create_comment(story_public_id, input_comment)

View Source

Create a comment within a story

Example

iex> ExClubhouse.Api.Story.create_comment(1, ExClubhouse.Model.Input.Comment{...})
{:ok, %ExClubhouse.Model.Comment{...}}
Link to this function

create_comment(session, story_public_id, input_comment)

View Source
Link to this function

create_reaction(story_public_id, comment_public_id, input_reaction)

View Source

Create a comment reaction

Example

iex> ExClubhouse.Api.Story.create_reaction(1,2, ExClubhouse.Model.Input.Reaction{...})
{:ok, %ExClubhouse.Model.Reaction{...}}
Link to this function

create_reaction(session, story_public_id, comment_public_id, input_reaction)

View Source
Link to this function

create_task(story_public_id, input_task)

View Source

Create a story task

Example

iex> ExClubhouse.Api.Story.create_task(ExClubhouse.Model.Input.Task{...})
{:ok, %ExClubhouse.Model.Task{...}}
Link to this function

create_task(session, story_public_id, input_task)

View Source
Link to this function

delete(story_public_id)

View Source
delete(integer()) :: :ok | {:error, ExClubhouse.Error.t()}

Delete a Story

## Example

iex> ExClubhouse.Api.Story.delete(1)
:ok
Link to this function

delete(session, story_public_id)

View Source
delete(ExClubhouse.Session.t(), integer()) ::
  :ok | {:error, ExClubhouse.Error.t()}
Link to this function

delete_comment(story_public_id, comment_public_id)

View Source
delete_comment(integer(), integer()) :: :ok | {:error, ExClubhouse.Error.t()}

Delete a comment

## Example

iex> ExClubhouse.Api.Story.delete_comment(1, 2)
:ok
Link to this function

delete_comment(session, story_public_id, comment_public_id)

View Source
delete_comment(ExClubhouse.Session.t(), integer(), integer()) ::
  :ok | {:error, ExClubhouse.Error.t()}
Link to this function

delete_reaction(story_public_id, comment_public_id)

View Source
delete_reaction(integer(), integer()) :: :ok | {:error, ExClubhouse.Error.t()}

Delete a reaction

## Example

iex> ExClubhouse.Api.Story.delete_reaction(1, 2)
:ok
Link to this function

delete_reaction(session, story_public_id, comment_public_id)

View Source
delete_reaction(ExClubhouse.Session.t(), integer(), integer()) ::
  :ok | {:error, ExClubhouse.Error.t()}
Link to this function

delete_task(story_public_id, task_public_id)

View Source
delete_task(integer(), integer()) :: :ok | {:error, ExClubhouse.Error.t()}

Delete a task

## Example

iex> ExClubhouse.Api.Story.delete_task(1)
:ok
Link to this function

delete_task(session, story_public_id, task_public_id)

View Source
delete_task(ExClubhouse.Session.t(), integer(), integer()) ::
  :ok | {:error, ExClubhouse.Error.t()}
Link to this function

get(story_public_id)

View Source
get(integer()) ::
  {:error, ExClubhouse.Error.t()} | {:ok, nil | ExClubhouse.Model.Story.t()}

Get a single Story by id

Example

iex> ExClubhouse.Api.Story.get(1)
{:ok, %ExClubhouse.Model.Story{...}}
Link to this function

get(session, story_public_id)

View Source
Link to this function

get_comment(story_public_id, comment_public_id)

View Source
get_comment(integer(), integer()) ::
  {:error, ExClubhouse.Error.t()} | {:ok, nil | ExClubhouse.Model.Comment.t()}

Get a single comment

Example

iex> ExClubhouse.Api.Story.get_comment(1, 2)
{:ok, %ExClubhouse.Model.Comment{...}}
Link to this function

get_comment(session, story_public_id, comment_public_id)

View Source
get_comment(ExClubhouse.Session.t(), integer(), integer()) ::
  {:ok, ExClubhouse.Model.Comment.t() | nil} | {:error, ExClubhouse.Error.t()}
Link to this function

get_task(story_public_id, task_public_id)

View Source
get_task(integer(), integer()) ::
  {:error, ExClubhouse.Error.t()} | {:ok, nil | ExClubhouse.Model.Task.t()}

Get a single task by id

Example

iex> ExClubhouse.Api.Story.get_task(1, 2)
{:ok, %ExClubhouse.Model.Task{...}}
Link to this function

get_task(session, story_public_id, task_public_id)

View Source
get_task(ExClubhouse.Session.t(), integer(), integer()) ::
  {:ok, ExClubhouse.Model.Task.t() | nil} | {:error, ExClubhouse.Error.t()}
Link to this function

update(story_public_id, story_input)

View Source

Update a Story

Example

iex> ExClubhouse.Api.Story.update(1, ExClubhouse.Model.Input.Story{...})
{:ok, %ExClubhouse.Model.Story{...}}
Link to this function

update_comment(story_public_id, comment_public_id, update_comment_input)

View Source

Update a comment

Example

iex> ExClubhouse.Api.Story.update_comment(1, 2, ExClubhouse.Model.Input.UpdateComment{...})
{:ok, %ExClubhouse.Model.Comment{...}}
Link to this function

update_comment(session, story_public_id, comment_public_id, update_comment_input)

View Source
Link to this function

update_task(story_public_id, task_public_id, update_task_input)

View Source

Update a task

Example

iex> ExClubhouse.Api.Story.update_task(1, 2, ExClubhouse.Model.Input.UpdateTask{...})
{:ok, %ExClubhouse.Model.Task{...}}
Link to this function

update_task(session, story_public_id, task_public_id, update_task_input)

View Source