/*! * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the Microsoft Live Share SDK License. */ import { UserMeetingRole } from "@microsoft/live-share"; import { IUseLiveFollowModeResults } from "../types"; /** * React hook for using a Live Share `LiveFollowMode`. * * @remarks * Use this hook if you want to add the ability to follow specific users or let a user present to everyone in the session. * Each user has their own `stateValue`, which is the value other users will reference when that user is presenting or being followed. * The `state` response includes the user's `value` that the local user is "following", whether it be their own or someone else's. * This hook can only be used in a child component of `` or ``. * * @template TData Optional typing for the custom user presence data object. Default is `object` type. * * @param uniqueKey The unique key for `LiveFollowMode`. If one does not yet exist, a new one will be created. * @param initialData The initial value for the local user's `stateValue`. * @param allowedRoles Optional. The user roles that are allowed to present to use `startPresenting()` or `stopPresenting()`. * @returns `IUseLiveFollowModeResults` results, which contains React stateful objects and callbacks. */ export declare function useLiveFollowMode(uniqueKey: string, initialData: TData | (() => TData), allowedRoles?: UserMeetingRole[]): IUseLiveFollowModeResults; //# sourceMappingURL=useLiveFollowMode.d.ts.map