@microsoft/msgraph-sdk-communications
Version:
Communications fluent API for Microsoft Graph
97 lines • 4.57 kB
TypeScript
import { type EngagementConversationMessage, type EngagementConversationMessageCollectionResponse } from '@microsoft/msgraph-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type EngagementConversationMessageItemRequestBuilder } from './item/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
* Provides operations to manage the messages property of the microsoft.graph.engagementConversation entity.
*/
export interface MessagesRequestBuilder extends BaseRequestBuilder<MessagesRequestBuilder> {
/**
* Provides operations to count the resources in the collection.
*/
get count(): CountRequestBuilder;
/**
* Provides operations to manage the messages property of the microsoft.graph.engagementConversation entity.
* @param engagementConversationMessageId The unique identifier of engagementConversationMessage
* @returns {EngagementConversationMessageItemRequestBuilder}
*/
byEngagementConversationMessageId(engagementConversationMessageId: string): EngagementConversationMessageItemRequestBuilder;
/**
* The messages in a Viva Engage conversation.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<EngagementConversationMessageCollectionResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
get(requestConfiguration?: RequestConfiguration<MessagesRequestBuilderGetQueryParameters> | undefined): Promise<EngagementConversationMessageCollectionResponse | undefined>;
/**
* Create new navigation property to messages for communications
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<EngagementConversationMessage>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
post(body: EngagementConversationMessage, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<EngagementConversationMessage | undefined>;
/**
* The messages in a Viva Engage conversation.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<MessagesRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Create new navigation property to messages for communications
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPostRequestInformation(body: EngagementConversationMessage, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* The messages in a Viva Engage conversation.
*/
export interface MessagesRequestBuilderGetQueryParameters {
/**
* Include count of items
*/
count?: boolean;
/**
* Expand related entities
*/
expand?: string[];
/**
* Filter items by property values
*/
filter?: string;
/**
* Order items by property values
*/
orderby?: string[];
/**
* Search items by search phrases
*/
search?: string;
/**
* Select properties to be returned
*/
select?: string[];
/**
* Skip the first n items
*/
skip?: number;
/**
* Show only the first n items
*/
top?: number;
}
/**
* Uri template for the request builder.
*/
export declare const MessagesRequestBuilderUriTemplate = "{+baseurl}/communications/onlineMeetingConversations/{onlineMeetingEngagementConversation%2Did}/messages{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const MessagesRequestBuilderNavigationMetadata: Record<Exclude<keyof MessagesRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const MessagesRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map