![]() ![]() If true, this will be a group conversation (i.e. When false, individual private conversations will be created with each recipient. Maximum length is 255 characters.įorces a new message to be created, even if there is an existing private conversation.ĭefaults to false. This is ignored when reusing a conversation. If the course/group has over 100 enrollments, 'bulk_message' and 'group_conversation' must be set to true. recipients=1&recipients=2&recipients=course_3. These may be user ids or course/group ids prefixed with “course_” or “group_” respectively, e.g. Request Parameters: ParameterĪn array of recipient ids. If there is already an existing private conversation with the given recipients, it will be reused. Optionally include an “avatar_url” key for each user participanting in the conversationĬreate a new conversation with one or more recipients. If true, the top-level element of the response will be an object rather than an array, and will have the keys “conversations” which will contain the paged conversation data, and “conversation_ids” which will contain the ids of all conversations under this scope/filter in the same order. This parameter is ignored.ĭefault is false. (Obsolete) Submissions are no longer linked to conversations. When filter contains multiple filters, combine them with this mode, filtering conversations that at have at least all of the contexts (“and”) or at least one of the contexts (“or”) Can be an array (by setting “filter”) or single value (by setting “filter”) The id should be prefixed with its type, e.g. ![]() When set, only return conversations for the specified courses, groups or users. read and unread).Īllowed values: unread, starred, archived The default behavior is to return all non-archived conversations (i.e. For example, set to “unread” to return only conversations that haven't been read. When set, only return conversations of the specified type. Returns the paginated list of conversations for the current user, most recent ones first. Name of the course or group in which the conversation is occurring. scope or filter is passed to the create/update API call. primarily useful in create/update responses so that you can know if the This attribute is always true in the index API response, and is indicates whether the conversation is visible under the current scope and Array of users participating in the conversation. URL to appropriate icon for this conversation (custom, individual or group that user's enrollment(s)/ membership type(s) in each course/group. If there is only one participant, it will also include Most relevant shared contexts (courses and groups) between current user and participation level, then alphabetical. Array of user ids who are involved in the conversation, ordered by most recent author, there are attachments, or there are media objects) listed property means the flag is set to true (i.e. Additional conversation flags (last_author, attachments, media_objects). whether the current user is subscribed to the conversation. the number of messages in the conversation. the date and time at which the last message was sent. "last_message": "sure thing, here's the file", A <=100 character preview from the most recent message. ![]() The current state of the conversation (read, unread or archived). the unique identifier for the conversation. ![]()
0 Comments
Leave a Reply. |