UNPKG

@microsoft/msgraph-sdk-chats

Version:
99 lines 4.42 kB
import { type TeamsTab, type TeamsTabCollectionResponse } from '@microsoft/msgraph-sdk/models/index.js'; import { type CountRequestBuilder } from './count/index.js'; import { type TeamsTabItemRequestBuilder } 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 tabs property of the microsoft.graph.chat entity. */ export interface TabsRequestBuilder extends BaseRequestBuilder<TabsRequestBuilder> { /** * Provides operations to count the resources in the collection. */ get count(): CountRequestBuilder; /** * Provides operations to manage the tabs property of the microsoft.graph.chat entity. * @param teamsTabId The unique identifier of teamsTab * @returns {TeamsTabItemRequestBuilder} */ byTeamsTabId(teamsTabId: string): TeamsTabItemRequestBuilder; /** * Retrieve the list of tabs in the specified chat. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<TeamsTabCollectionResponse>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/chat-list-tabs?view=graph-rest-1.0|Find more info here} */ get(requestConfiguration?: RequestConfiguration<TabsRequestBuilderGetQueryParameters> | undefined): Promise<TeamsTabCollectionResponse | undefined>; /** * Add (pin) a tab to the specified chat. The corresponding app must already be installed in the chat. * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<TeamsTab>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/chat-post-tabs?view=graph-rest-1.0|Find more info here} */ post(body: TeamsTab, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<TeamsTab | undefined>; /** * Retrieve the list of tabs in the specified chat. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toGetRequestInformation(requestConfiguration?: RequestConfiguration<TabsRequestBuilderGetQueryParameters> | undefined): RequestInformation; /** * Add (pin) a tab to the specified chat. The corresponding app must already be installed in the chat. * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toPostRequestInformation(body: TeamsTab, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation; } /** * Retrieve the list of tabs in the specified chat. */ export interface TabsRequestBuilderGetQueryParameters { /** * 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 TabsRequestBuilderUriTemplate = "{+baseurl}/chats/{chat%2Did}/tabs{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}"; /** * Metadata for all the navigation properties in the request builder. */ export declare const TabsRequestBuilderNavigationMetadata: Record<Exclude<keyof TabsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>; /** * Metadata for all the requests in the request builder. */ export declare const TabsRequestBuilderRequestsMetadata: RequestsMetadata; //# sourceMappingURL=index.d.ts.map