Ltix.LaunchClaims.ResourceLink (Ltix v0.1.0)

Copy Markdown View Source

A placement of an LTI resource link within a context.

id is required and stable across launches for the same link.

Examples

iex> Ltix.LaunchClaims.ResourceLink.from_json(%{"id" => "rl-1", "title" => "Quiz"})
{:ok, %Ltix.LaunchClaims.ResourceLink{id: "rl-1", title: "Quiz", description: nil}}

Summary

Types

t()

Functions

from_json(json)

Parse a resource link claim from a JSON map.

Types

t()

@type t() :: %Ltix.LaunchClaims.ResourceLink{
  description: binary(),
  id: binary(),
  title: binary()
}

Functions

from_json(json)

@spec from_json(map()) :: {:ok, t()} | {:error, Exception.t()}

Parse a resource link claim from a JSON map.

Examples

iex> Ltix.LaunchClaims.ResourceLink.from_json(%{"id" => "rl-1"})
{:ok, %Ltix.LaunchClaims.ResourceLink{id: "rl-1", title: nil, description: nil}}