Specs

create_conversation(
  service_url :: String.t(),
  params :: ExMicrosoftBot.Models.ConversationParameters.t()
) ::
  {:ok, ExMicrosoftBot.Models.ConversationResourceResponse.t()}
  | ExMicrosoftBot.Client.error_type()

Create a new Conversation.

@see API Reference

Specs

delete_activity(
  service_url :: String.t(),
  conversation_id :: String.t(),
  activity_or_id :: ExMicrosoftBot.Models.Activity.t() | String.t()
) :: {:ok, binary()} | ExMicrosoftBot.Client.error_type()

Deletes an existing activity. The returned content will always be empty. @see API Reference

Specs

get_member(
  service_url :: String.t(),
  conversation_id :: String.t(),
  member_id :: String.t()
) ::
  {:ok, ExMicrosoftBot.Models.ChannelAccount.t()}
  | ExMicrosoftBot.Client.error_type()

This function takes a conversation ID and a member ID and returns a ChannelAccount struct for that member of the conversation.

@see API Reference.

Specs

get_members(
  service_url :: String.t(),
  conversation_id :: String.t(),
  activity_id :: String.t() | nil
) ::
  {:ok, [ExMicrosoftBot.Models.ChannelAccount.t()]}
  | ExMicrosoftBot.Client.error_type()

This function takes a ConversationId and returns an array of ChannelAccount[] objects which are the members of the conversation. @see API Reference.

When ActivityId is passed in then it returns the members of the particular activity in the conversation.

@see API Reference

Specs

reply_to_activity(
  conversation_id :: String.t(),
  activity_id :: String.t(),
  activity :: ExMicrosoftBot.Models.Activity.t()
) ::
  {:ok, ExMicrosoftBot.Models.ResourceResponse.t()}
  | ExMicrosoftBot.Client.error_type()

This method allows you to reply to an activity. @see API Reference

Specs

reply_to_activity(
  service_url :: String.t(),
  conversation_id :: String.t(),
  activity_id :: String.t(),
  activity :: ExMicrosoftBot.Models.Activity.t()
) ::
  {:ok, ExMicrosoftBot.Models.ResourceResponse.t()}
  | ExMicrosoftBot.Client.error_type()

This method allows you to reply to an activity. @see API Reference

Specs

send_to_conversation(
  conversation_id :: String.t(),
  activity :: ExMicrosoftBot.Models.Activity.t()
) ::
  {:ok, ExMicrosoftBot.Models.ResourceResponse.t()}
  | ExMicrosoftBot.Client.error_type()

This method allows you to send an activity to a conversation regardless of previous posts to a conversation.

@see API Reference

Specs

send_to_conversation(
  service_url :: String.t(),
  conversation_id :: String.t(),
  activity :: ExMicrosoftBot.Models.Activity.t()
) ::
  {:ok, ExMicrosoftBot.Models.ResourceResponse.t()}
  | ExMicrosoftBot.Client.error_type()

This method allows you to send an activity to a conversation regardless of previous posts to a conversation.

@see API Reference

Specs

update_activity(
  service_url :: String.t(),
  conversation_id :: String.t(),
  activity :: ExMicrosoftBot.Models.Activity.t()
) ::
  {:ok, ExMicrosoftBot.Models.ResourceResponse.t()}
  | ExMicrosoftBot.Client.error_type()

Updates an existing activity. The activity struct is expected to have an ID. @see API Reference

Specs

upload_attachment(
  service_url :: String.t(),
  conversation_id :: String.t(),
  attachment :: ExMicrosoftBot.Models.AttachmentData.t()
) ::
  {:ok, ExMicrosoftBot.Models.ResourceResponse.t()}
  | ExMicrosoftBot.Client.error_type()

This method allows you to upload an attachment directly into a channels blob storage.

@see API Reference