@microsoft/msgraph-beta-sdk-groups
Version:
Groups fluent API for Microsoft Graph
60 lines • 4.6 kB
TypeScript
import { type AdditionalDataHolder, type BackedModel, type BaseRequestBuilder, type Parsable, type ParseNode, type RequestConfiguration, type RequestInformation, type RequestsMetadata, type SerializationWriter } from '@microsoft/kiota-abstractions';
export interface ArchivePostRequestBody extends AdditionalDataHolder, BackedModel, Parsable {
/**
* Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
*/
additionalData?: Record<string, unknown>;
/**
* Stores model information.
*/
backingStoreEnabled?: boolean | null;
/**
* The shouldSetSpoSiteReadOnlyForMembers property
*/
shouldSetSpoSiteReadOnlyForMembers?: boolean | null;
}
/**
* Provides operations to call the archive method.
*/
export interface ArchiveRequestBuilder extends BaseRequestBuilder<ArchiveRequestBuilder> {
/**
* Archive a channel in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel. You can delete an archived channel or add and remove members from it. If you archive a team, its channels are also archived. Archiving is an asynchronous operation; a channel is archived after the asynchronous archiving operation completes successfully, which might occur after the response returns. A channel without an owner or that belongs to a group that has no owner, can't be archived. To restore a channel from its archived state, use the channel: unarchive method. A channel can’t be archived or unarchived if its team is archived.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/channel-archive?view=graph-rest-beta|Find more info here}
*/
post(body: ArchivePostRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
/**
* Archive a channel in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel. You can delete an archived channel or add and remove members from it. If you archive a team, its channels are also archived. Archiving is an asynchronous operation; a channel is archived after the asynchronous archiving operation completes successfully, which might occur after the response returns. A channel without an owner or that belongs to a group that has no owner, can't be archived. To restore a channel from its archived state, use the channel: unarchive method. A channel can’t be archived or unarchived if its team is archived.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPostRequestInformation(body: ArchivePostRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Creates a new instance of the appropriate class based on discriminator value
* @param parseNode The parse node to use to read the discriminator value and create the object
* @returns {ArchivePostRequestBody}
*/
export declare function createArchivePostRequestBodyFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
* The deserialization information for the current model
* @returns {Record<string, (node: ParseNode) => void>}
*/
export declare function deserializeIntoArchivePostRequestBody(archivePostRequestBody?: Partial<ArchivePostRequestBody> | undefined): Record<string, (node: ParseNode) => void>;
/**
* Serializes information the current object
* @param writer Serialization writer to use to serialize this model
*/
export declare function serializeArchivePostRequestBody(writer: SerializationWriter, archivePostRequestBody?: Partial<ArchivePostRequestBody> | undefined | null): void;
/**
* Uri template for the request builder.
*/
export declare const ArchiveRequestBuilderUriTemplate = "{+baseurl}/groups/{group%2Did}/team/primaryChannel/archive";
/**
* Metadata for all the requests in the request builder.
*/
export declare const ArchiveRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map