Typetalk v0.1.2 Typetalk

A Typetalk API client library.

API Doc

Summary

Functions

Mark a topic as favorite

Get direct messages from an account

Returns direct message topics

Returns the profile of the given account name

Returns a topic message

Returns messages of a topic

Get notification status

Get notifications

Returns the online status of accounts

Returns the profile of the caller

Returns space members

Returns the space information

Returns messages of a talk

Returns talks of a topic

Returns topic information

Returns topic members

Returns the topics

Give a like to a message

Mark notifications as read

Mark all messages in a mention as read

Mark all messages in a mention as read

Get information of an account

Remove a topic from favorite

Delete a like from a message

Types

access_token()
access_token() :: Typetalk.AccessToken.t
token()
type_talk_token()
type_talk_token() :: binary

Functions

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

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

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

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

Delete a topic message.

API Doc

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

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

Deletes a talk.

API Doc

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

Delete a topic.

API Doc

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

favorite_topic(token, topic_id)
favorite_topic(token, String.t) :: {:ok, map} | {:error, map}

Mark a topic as favorite.

API Doc

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

Get direct messages from an account.

API Doc

get_dm_topics(token)
get_dm_topics(token) :: {:ok, map} | {:error, map}

Returns direct message topics.

API Doc

get_friend_profile(token, account_name)
get_friend_profile(token, String.t) ::
  {:ok, map} |
  {:error, map}

Returns the profile of the given account name.

API Doc

get_mentions(token, options \\ [])
get_mentions(token, Keyword.t) :: {:ok, map} | {:error, map}

Returns mentions

API Doc

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

Returns a topic message.

API Doc

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

Returns messages of a topic.

API Doc

get_notification_status(token)
get_notification_status(token) :: {:ok, map} | {:error, map}

Get notification status.

API Doc

get_notifications(token)
get_notifications(token) :: {:ok, map} | {:error, map}

Get notifications.

API Doc

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

Returns the online status of accounts.

API Doc

get_profile(token)
get_profile(token) :: {:ok, map} | {:error, map}

Returns the profile of the caller.

API Doc

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

Returns space members.

API Doc

get_spaces(token)
get_spaces(token) :: {:ok, map} | {:error, map}

Returns the space information.

API Doc

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

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

Returns talks of a topic.

API Doc

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

Returns topic information.

API Doc

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

Returns topic members.

API Doc

get_topics(token)
get_topics(token) :: {:ok, map} | {:error, map}

Returns the topics.

API Doc

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

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

mark_notifications_as_read(token)
mark_notifications_as_read(token) :: {:ok, map} | {:error, map}

Mark notifications as read.

API Doc

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

Mark all messages in a mention as read.

API Doc

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 mention as read.

API Doc

post_direct_message(token, account_name, message, options)
post_direct_message(token, String.t, String.t, Keyword.t) ::
  {:ok, map} |
  {:error, map}

Post a direct message.

API Doc

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

search_account(token, name_or_email)
search_account(token, String.t) :: {:ok, map} | {:error, map}

Get information of an account.

API Doc

search_friends(token, q, options \\ [])
search_friends(token, String.t, Keyword.t) ::
  {:ok, map} |
  {:error, map}

Searches friends.

Options

  • :offset
  • :count

API Doc

unfavorite_topic(token, topic_id)
unfavorite_topic(token, String.t) ::
  {:ok, map} |
  {:error, map}

Remove a topic from favorite.

API Doc

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

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

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

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

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

Update topic members.

API Doc

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

Upload an attachment file.

API Doc