Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

ms_chat_message

Teams chat message


Description

Class representing a message in a Teams channel. Currently Microsoft365R only supports channels, not chats between individuals.

Format

An R6 object of class ms_chat_message, inheriting from ms_object.

Fields

  • token: The token used to authenticate with the Graph host.

  • tenant: The Azure Active Directory tenant for the parent drive.

  • type: Always "Teams message" for a chat message object.

  • properties: The item properties (metadata).

Methods

  • new(...): Initialize a new object. Do not call this directly; see 'Initialization' below.

  • delete(confirm=TRUE): Delete this message. Currently the Graph API does not support deleting Teams messages, so this method is disabled.

  • update(...): Update the message's properties (metadata) in Microsoft Graph.

  • do_operation(...): Carry out an arbitrary operation on the message.

  • sync_fields(): Synchronise the R object with the message metadata in Microsoft Graph.

  • send_reply(body, content_type, attachments): Sends a reply to the message. See below.

  • list_replies(n=50): List the replies to this message. By default, this is limited to the 50 most recent replies; set the n argument to change this.

  • get_reply(message_id): Retrieves a specific reply to the message.

  • delete_reply(message_id, confirm=TRUE): Deletes a reply to the message. Currently the Graph API does not support deleting Teams messages, so this method is disabled.

Initialization

Creating new objects of this class should be done via the get_message and list_messages method of the ms_team class. Calling the new() method for this class only constructs the R object; it does not call the Microsoft Graph API to retrieve or create the actual message.

Replying to a message

To reply to a message, use the send_reply() method. This has arguments:

  • body: The body of the message. This should be a character vector, which will be concatenated into a single string with newline separators. The body can be either plain text or HTML formatted.

  • content_type: Either "text" (the default) or "html".

  • attachments: Optional vector of filenames.

  • inline: Optional vector of image filenames that will be inserted into the body of the message. The images must be PNG or JPEG, and the content_type argument must be "html" to include inline content.

Teams channels don't support nested replies, so any methods dealing with replies will fail if the message object is itself a reply.

Note that message attachments are actually uploaded to the channel's file listing (a directory in the team's primary shared document folder). Support for attachments is somewhat experimental, so if you want to be sure that it works, upload the file separately using the channel's upload_file() method.

See Also

Examples

## Not run: 

myteam <- get_team("my team")

chan <- myteam$get_channel()
msg <- chan$list_messages()[[1]]
msg$list_replies()
msg$send_reply("Reply from R")


## End(Not run)

Microsoft365R

Interface to the 'Microsoft 365' Suite of Cloud Services

v2.1.0
MIT + file LICENSE
Authors
Hong Ooi [aut, cre], Microsoft [cph]
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.