@microsoft/msgraph-beta-sdk-groups
Version:
Groups fluent API for Microsoft Graph
112 lines • 4.86 kB
TypeScript
import { type Channel, type ChannelCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type AllMessagesRequestBuilder } from './allMessages/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type GetAllMessagesRequestBuilder } from './getAllMessages/index.js';
import { type GetAllRetainedMessagesRequestBuilder } from './getAllRetainedMessages/index.js';
import { type ChannelItemRequestBuilder } 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 channels property of the microsoft.graph.team entity.
*/
export interface ChannelsRequestBuilder extends BaseRequestBuilder<ChannelsRequestBuilder> {
/**
* Provides operations to call the allMessages method.
*/
get allMessages(): AllMessagesRequestBuilder;
/**
* Provides operations to count the resources in the collection.
*/
get count(): CountRequestBuilder;
/**
* Provides operations to call the getAllMessages method.
*/
get getAllMessages(): GetAllMessagesRequestBuilder;
/**
* Provides operations to call the getAllRetainedMessages method.
*/
get getAllRetainedMessages(): GetAllRetainedMessagesRequestBuilder;
/**
* Provides operations to manage the channels property of the microsoft.graph.team entity.
* @param channelId The unique identifier of channel
* @returns {ChannelItemRequestBuilder}
*/
byChannelId(channelId: string): ChannelItemRequestBuilder;
/**
* The collection of channels and messages associated with the team.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<ChannelCollectionResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
get(requestConfiguration?: RequestConfiguration<ChannelsRequestBuilderGetQueryParameters> | undefined): Promise<ChannelCollectionResponse | undefined>;
/**
* Create new navigation property to channels for groups
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<Channel>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
post(body: Channel, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Channel | undefined>;
/**
* The collection of channels and messages associated with the team.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<ChannelsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Create new navigation property to channels for groups
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPostRequestInformation(body: Channel, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* The collection of channels and messages associated with the team.
*/
export interface ChannelsRequestBuilderGetQueryParameters {
/**
* 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 ChannelsRequestBuilderUriTemplate = "{+baseurl}/groups/{group%2Did}/team/channels{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const ChannelsRequestBuilderNavigationMetadata: Record<Exclude<keyof ChannelsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const ChannelsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map