Function: conversation()

Call Signature

function conversation(
   context, 
   siteUrl, 
   conversationId, 
   options
): Promise<Conversation<ListPage<ConversationMessage>>>;

Defined in: areas/messages/messages.ts:206

A conversation's messages, oldest first, as text, and its members as conversations() gives them: everyone but the person, whether they wrote in it or not (the person alone in their own conversation). With limit, messages is a page of them (see "Long lists" in the docs' concepts) counted from the newest: the first page is the latest messages, more says there are older ones, and each page's messages still come oldest first. Moodle's service returns only the page.

Parameters

Parameter	Type
context	BrowserContext
siteUrl	string
conversationId	number
options	WithLimit<PageOptions>

Returns

Promise<Conversation<ListPage<ConversationMessage>>>

Call Signature

function conversation(
   context, 
   siteUrl, 
   conversationId, 
   options?
): Promise<Conversation<ConversationMessage[]>>;

Defined in: areas/messages/messages.ts:207

A conversation's messages, oldest first, as text, and its members as conversations() gives them: everyone but the person, whether they wrote in it or not (the person alone in their own conversation). With limit, messages is a page of them (see "Long lists" in the docs' concepts) counted from the newest: the first page is the latest messages, more says there are older ones, and each page's messages still come oldest first. Moodle's service returns only the page.

Parameters

Parameter	Type
context	BrowserContext
siteUrl	string
conversationId	number
options?	WithoutLimit<PageOptions>

Returns

Promise<Conversation<ConversationMessage[]>>

Call Signature

function conversation(
   context, 
   siteUrl, 
   conversationId, 
   options?
): Promise<Conversation<
  | ConversationMessage[]
| ListPage<ConversationMessage>>>;

Defined in: areas/messages/messages.ts:208

A conversation's messages, oldest first, as text, and its members as conversations() gives them: everyone but the person, whether they wrote in it or not (the person alone in their own conversation). With limit, messages is a page of them (see "Long lists" in the docs' concepts) counted from the newest: the first page is the latest messages, more says there are older ones, and each page's messages still come oldest first. Moodle's service returns only the page.

Parameters

Parameter	Type
context	BrowserContext
siteUrl	string
conversationId	number
options?	PageOptions

Returns

Promise<Conversation< | ConversationMessage[] | ListPage<ConversationMessage>>>