UNPKG

@microsoft/msgraph-sdk-teams

Version:
68 lines 5.56 kB
import { type ProfilePhoto } from '@microsoft/msgraph-sdk/models/index.js'; import { type ContentRequestBuilder } from './value/index.js'; import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions'; /** * Provides operations to manage the photo property of the microsoft.graph.team entity. */ export interface PhotoRequestBuilder extends BaseRequestBuilder<PhotoRequestBuilder> { /** * Provides operations to manage the media for the team entity. */ get content(): ContentRequestBuilder; /** * Get the specified profilePhoto or its metadata (profilePhoto properties). The supported sizes of HD photos on Microsoft 365 are as follows: 48x48, 64x64, 96x96, 120x120, 240x240,360x360, 432x432, 504x504, and 648x648. Photos can be any dimension if they're stored in Microsoft Entra ID. You can get the metadata of the largest available photo or specify a size to get the metadata for that photo size.If the size you request is unavailable, you can still get a smaller size that the user has uploaded and made available.For example, if the user uploads a photo that is 504x504 pixels, all but the 648x648 size of the photo is available for download. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<ProfilePhoto>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/profilephoto-get?view=graph-rest-1.0|Find more info here} */ get(requestConfiguration?: RequestConfiguration<PhotoRequestBuilderGetQueryParameters> | undefined): Promise<ProfilePhoto | undefined>; /** * Update the photo for the specified contact, group, team, or user in a tenant. The size of the photo you can update to is limited to 4 MB. You can use either PATCH or PUT for this operation. * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<ProfilePhoto>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/profilephoto-update?view=graph-rest-1.0|Find more info here} */ patch(body: ProfilePhoto, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<ProfilePhoto | undefined>; /** * Get the specified profilePhoto or its metadata (profilePhoto properties). The supported sizes of HD photos on Microsoft 365 are as follows: 48x48, 64x64, 96x96, 120x120, 240x240,360x360, 432x432, 504x504, and 648x648. Photos can be any dimension if they're stored in Microsoft Entra ID. You can get the metadata of the largest available photo or specify a size to get the metadata for that photo size.If the size you request is unavailable, you can still get a smaller size that the user has uploaded and made available.For example, if the user uploads a photo that is 504x504 pixels, all but the 648x648 size of the photo is available for download. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toGetRequestInformation(requestConfiguration?: RequestConfiguration<PhotoRequestBuilderGetQueryParameters> | undefined): RequestInformation; /** * Update the photo for the specified contact, group, team, or user in a tenant. The size of the photo you can update to is limited to 4 MB. You can use either PATCH or PUT for this operation. * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toPatchRequestInformation(body: ProfilePhoto, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation; } /** * Get the specified profilePhoto or its metadata (profilePhoto properties). The supported sizes of HD photos on Microsoft 365 are as follows: 48x48, 64x64, 96x96, 120x120, 240x240,360x360, 432x432, 504x504, and 648x648. Photos can be any dimension if they're stored in Microsoft Entra ID. You can get the metadata of the largest available photo or specify a size to get the metadata for that photo size.If the size you request is unavailable, you can still get a smaller size that the user has uploaded and made available.For example, if the user uploads a photo that is 504x504 pixels, all but the 648x648 size of the photo is available for download. */ export interface PhotoRequestBuilderGetQueryParameters { /** * Expand related entities */ expand?: string[]; /** * Select properties to be returned */ select?: string[]; } /** * Uri template for the request builder. */ export declare const PhotoRequestBuilderUriTemplate = "{+baseurl}/teams/{team%2Did}/photo{?%24expand,%24select}"; /** * Metadata for all the navigation properties in the request builder. */ export declare const PhotoRequestBuilderNavigationMetadata: Record<Exclude<keyof PhotoRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>; /** * Metadata for all the requests in the request builder. */ export declare const PhotoRequestBuilderRequestsMetadata: RequestsMetadata; //# sourceMappingURL=index.d.ts.map