Typetalk

v0.2.0

Typetalk v0.2.0 Typetalk

A Typetalk API client library.

API Doc

Link to this section Summary

Types

access_token()
token()
type_talk_token()

Functions

add_messages_to_talk(token, topic_id, talk_id, post_ids)

Add messages to a talk

create_talk(token, topic_id, name, post_ids)

Creates a new talk

create_topic(token, name, space_key, options \\ [])

Create a new topic

delete_message(token, topic_id, post_id)

Delete a topic message

delete_messages_from_talk(token, topic_id, talk_id, post_ids)

Deletes messages from a talk

delete_talk(token, topic_id, talk_id)

Deletes a talk

delete_topic(token, topic_id)

Delete a topic

download_attachment(token, topic_id, post_id, attachment_id, filename)

Download an attachment file

get_direct_messages(token, space_key, account_name, options \\ [])

Get direct messages from an account

get_dm_topics(token, space_key)

Returns direct message topics

get_friend_profile(token, space_key, options \\ [])

Returns the profile of the given account name

get_mentions(token, space_key, options \\ [])

Returns mentions

get_message(token, topic_id, post_id)

Returns a topic message

get_messages(token, topic_id)

Returns messages of a topic

get_notification_status(token)

Get notification status

get_online_status(token, account_ids)

Returns the online status of accounts

get_profile(token)

Returns the profile of the caller

get_space_members(token, space_key)

Returns space members

get_spaces(token)

Returns the space information

get_talk_messages(token, topic_id, talk_id)

Returns messages of a talk

get_talks(token, topic_id)

Returns talks of a topic

get_topic_details(token, topic_id)

Returns topic information

get_topic_members(token, topic_id)

Returns topic members

get_topics(token, space_key)

Returns the topics

like_message(token, topic_id, post_id)

Give a like to a message

mark_mention_as_read(token, mention_id)

Mark a mention as read

mark_notifications_as_read(token, space_key)

Mark notifications as read

mark_topic_as_read(token, topic_id)

Mark all messages in a topic as read

mark_topic_as_read(token, topic_id, post_id)

Mark all messages in a topic as read

post_direct_message(token, space_key, account_name, message, options)

Post a direct message

post_message(token, topic_id, message, options \\ [])

Post a message to a topic

search_friends(token, space_key, q, options \\ [])

Searches friends

search_messages(token, q, space_key, options)

You can search through posted messages with this API

unlike_message(token, topic_id, post_id)

Delete a like from a message

update_message(token, topic_id, post_id, message)

Update a topic message

update_talk(token, topic_id, talk_id, name)

Changes a talk’s name

update_topic(token, topic_id, name, options \\ [])

Update a topic name

update_topic_members(token, topic_id, params)

Update topic members

upload_attachment(token, topic_id, filepath)

Upload an attachment file

Link to this section Types

Link to this type access_token() 
access_token() :: Typetalk.AccessToken.t()
Link to this type type_talk_token() 
type_talk_token() :: binary()

Link to this section Functions

Link to this function add_messages_to_talk(token, topic_id, talk_id, post_ids) 
add_messages_to_talk(token(), String.t(), String.t(), [integer()]) ::
  {:ok, map()} | {:error, map()}

Add messages to a talk.

API Doc

Link to this function create_talk(token, topic_id, name, post_ids) 
create_talk(token(), String.t(), String.t(), [integer()]) ::
  {:ok, map()} | {:error, map()}

Creates a new talk.

API Doc

Link to this function create_topic(token, name, space_key, options \\ []) 
create_topic(token(), String.t(), String.t(), Keyword.t()) ::
  {:ok, map()} | {:error, map()}

Create a new topic.

API Doc

Link to this function delete_message(token, topic_id, post_id) 
delete_message(token(), String.t(), String.t()) ::
  {:ok, map()} | {:error, map()}

Delete a topic message.

API Doc

Link to this function delete_messages_from_talk(token, topic_id, talk_id, post_ids) 
delete_messages_from_talk(token(), String.t(), String.t(), [integer()]) ::
  {:ok, map()} | {:error, map()}

Deletes messages from a talk.

API Doc

Link to this function delete_talk(token, topic_id, talk_id) 
delete_talk(token(), String.t(), String.t()) :: {:ok, map()} | {:error, map()}

Deletes a talk.

API Doc

Link to this function delete_topic(token, topic_id) 
delete_topic(token(), String.t()) :: {:ok, map()} | {:error, map()}

Delete a topic.

API Doc

Link to this function download_attachment(token, topic_id, post_id, attachment_id, filename) 
download_attachment(token(), String.t(), String.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, map()}

Download an attachment file.

API Doc

Link to this function get_direct_messages(token, space_key, account_name, options \\ []) 
get_direct_messages(token(), String.t(), String.t(), Keyword.t()) ::
  {:ok, map()} | {:error, map()}

Get direct messages from an account.

API Doc

Link to this function get_dm_topics(token, space_key) 
get_dm_topics(token(), String.t()) :: {:ok, map()} | {:error, map()}

Returns direct message topics.

API Doc

Link to this function get_friend_profile(token, space_key, options \\ []) 
get_friend_profile(token(), String.t(), Keyword.t()) ::
  {:ok, map()} | {:error, map()}

Returns the profile of the given account name.

API Doc

Link to this function get_mentions(token, space_key, options \\ []) 
get_mentions(token(), String.t(), Keyword.t()) ::
  {:ok, map()} | {:error, map()}

Returns mentions

API Doc

Link to this function get_message(token, topic_id, post_id) 
get_message(token(), String.t(), String.t()) :: {:ok, map()} | {:error, map()}

Returns a topic message.

API Doc

Link to this function get_messages(token, topic_id) 
get_messages(token(), String.t()) :: {:ok, map()} | {:error, map()}

Returns messages of a topic.

API Doc

Link to this function get_notification_status(token) 
get_notification_status(token()) :: {:ok, map()} | {:error, map()}

Get notification status.

API Doc

Link to this function get_online_status(token, account_ids) 
get_online_status(token(), [integer()]) :: {:ok, map()} | {:error, map()}

Returns the online status of accounts.

API Doc

Link to this function get_profile(token) 
get_profile(token()) :: {:ok, map()} | {:error, map()}

Returns the profile of the caller.

API Doc

Link to this function get_space_members(token, space_key) 
get_space_members(token(), String.t()) :: {:ok, map()} | {:error, map()}

Returns space members.

API Doc

Link to this function get_spaces(token) 
get_spaces(token()) :: {:ok, map()} | {:error, map()}

Returns the space information.

API Doc

Link to this function get_talk_messages(token, topic_id, talk_id) 
get_talk_messages(token(), String.t(), String.t()) ::
  {:ok, map()} | {:error, map()}

Returns messages of a talk.

API Doc

Link to this function get_talks(token, topic_id) 
get_talks(token(), String.t()) :: {:ok, map()} | {:error, map()}

Returns talks of a topic.

API Doc

Link to this function get_topic_details(token, topic_id) 
get_topic_details(token(), String.t()) :: {:ok, map()} | {:error, map()}

Returns topic information.

API Doc

Link to this function get_topic_members(token, topic_id) 
get_topic_members(token(), String.t()) :: {:ok, map()} | {:error, map()}

Returns topic members.

API Doc

Link to this function get_topics(token, space_key) 
get_topics(token(), String.t()) :: {:ok, map()} | {:error, map()}

Returns the topics.

API Doc

Link to this function like_message(token, topic_id, post_id) 
like_message(token(), String.t(), String.t()) ::
  {:ok, map()} | {:error, map()}

Give a like to a message.

API Doc

Link to this function mark_mention_as_read(token, mention_id) 
mark_mention_as_read(token(), String.t()) :: {:ok, map()} | {:error, map()}

Mark a mention as read.

API Doc

Link to this function mark_notifications_as_read(token, space_key) 
mark_notifications_as_read(token(), String.t()) ::
  {:ok, map()} | {:error, map()}

Mark notifications as read.

API Doc

Link to this function mark_topic_as_read(token, topic_id) 
mark_topic_as_read(token(), String.t()) :: {:ok, map()} | {:error, map()}

Mark all messages in a topic as read.

API Doc

Link to this function mark_topic_as_read(token, topic_id, post_id) 
mark_topic_as_read(token(), String.t(), String.t()) ::
  {:ok, map()} | {:error, map()}

Mark all messages in a topic as read.

API Doc

Link to this function post_direct_message(token, space_key, account_name, message, options) 
post_direct_message(token(), String.t(), String.t(), String.t(), Keyword.t()) ::
  {:ok, map()} | {:error, map()}

Post a direct message.

API Doc

Link to this function post_message(token, topic_id, message, options \\ []) 
post_message(token(), binary(), binary(), Keyword.t()) ::
  {:ok, map()} | {:error, map()}

Post a message to a topic.

options

  • :replyTo
  • :showLinkMeta
  • :fileKeys
  • :talkIds
  • :attachmentFileUrls
  • :attachmentFileNames

API Doc

Link to this function search_friends(token, space_key, q, options \\ [])

Searches friends.

Options

  • :offset
  • :count

API Doc

Link to this function search_messages(token, q, space_key, options)

You can search through posted messages with this API.

API Doc

Link to this function unlike_message(token, topic_id, post_id) 
unlike_message(token(), String.t(), String.t()) ::
  {:ok, map()} | {:error, map()}

Delete a like from a message.

API Doc

Link to this function update_message(token, topic_id, post_id, message) 
update_message(token(), String.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, map()}

Update a topic message.

API Doc

Link to this function update_talk(token, topic_id, talk_id, name) 
update_talk(token(), String.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, map()}

Changes a talk’s name.

API Doc

Link to this function update_topic(token, topic_id, name, options \\ []) 
update_topic(token(), String.t(), String.t(), Keyword.t()) ::
  {:ok, map()} | {:error, map()}

Update a topic name.

API Doc

Link to this function update_topic_members(token, topic_id, params) 
update_topic_members(token(), String.t(), Keyword.t()) ::
  {:ok, map()} | {:error, map()}

Update topic members.

API Doc

Link to this function upload_attachment(token, topic_id, filepath) 
upload_attachment(token(), String.t(), String.t()) ::
  {:ok, map()} | {:error, map()}

Upload an attachment file.

API Doc