@microsoft/msgraph-beta-sdk-groups
Version:
Groups fluent API for Microsoft Graph
78 lines • 3.18 kB
TypeScript
import { type ProfilePhotoCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type ProfilePhotoItemRequestBuilder } 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 photos property of the microsoft.graph.group entity.
*/
export interface PhotosRequestBuilder extends BaseRequestBuilder<PhotosRequestBuilder> {
/**
* Provides operations to manage the photos property of the microsoft.graph.group entity.
* @param profilePhotoId The unique identifier of profilePhoto
* @returns {ProfilePhotoItemRequestBuilder}
*/
byProfilePhotoId(profilePhotoId: string): ProfilePhotoItemRequestBuilder;
/**
* Retrieve a list of profilePhoto objects.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<ProfilePhotoCollectionResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/group-list-photos?view=graph-rest-beta|Find more info here}
*/
get(requestConfiguration?: RequestConfiguration<PhotosRequestBuilderGetQueryParameters> | undefined): Promise<ProfilePhotoCollectionResponse | undefined>;
/**
* Retrieve a list of profilePhoto objects.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<PhotosRequestBuilderGetQueryParameters> | undefined): RequestInformation;
}
/**
* Retrieve a list of profilePhoto objects.
*/
export interface PhotosRequestBuilderGetQueryParameters {
/**
* 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 PhotosRequestBuilderUriTemplate = "{+baseurl}/groups/{group%2Did}/photos{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const PhotosRequestBuilderNavigationMetadata: Record<Exclude<keyof PhotosRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const PhotosRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map