code_corps v0.0.1 CodeCorps.Comment.Service View Source

In charge of performing CRUD operations on Comment records, as well as any additional actions that need to be performed when such an operation happens.

Link to this section Summary

Types

record_result()

Functions

create(attributes)

Creates a Comment record using the provided parameters

update(comment, attributes)

Updates the provided Comment record using the provided parameters

Link to this section Types

record_result()

record_result() ::
  {:ok, CodeCorps.Comment.t()} |
  {:error, Ecto.Changeset.t()} |
  {:error, CodeCorps.GitHub.api_error_struct()}

Link to this section Functions

create(attributes)

create(map()) ::
  {:ok, CodeCorps.Comment.t()} |
  {:error, Ecto.Changeset.t()}

Creates a Comment record using the provided parameters

Also creates comment on GitHub if associated Task is github-connected.

update(comment, attributes)

update(CodeCorps.Comment.t(), map()) ::
  {:ok, CodeCorps.Comment.t()} |
  {:error, Ecto.Changeset.t()}

Updates the provided Comment record using the provided parameters