| 1 | /**
|
| 2 | * @module botbuilder
|
| 3 | */
|
| 4 | /**
|
| 5 | * Copyright (c) Microsoft Corporation. All rights reserved.
|
| 6 | * Licensed under the MIT License.
|
| 7 | */
|
| 8 | import { Activity, OnBehalfOf, TeamInfo, TeamsMeetingInfo, TenantInfo } from 'botbuilder-core';
|
| 9 | /**
|
| 10 | * Gets the Team's selected channel id from the current activity.
|
| 11 | *
|
| 12 | * @param activity The current [Activity](xref:botframework-schema.Activity).
|
| 13 | * @returns The current activity's team's selected channel, or empty string.
|
| 14 | */
|
| 15 | export declare function teamsGetSelectedChannelId(activity: Activity): string;
|
| 16 | /**
|
| 17 | * Gets the TeamsMeetingInfo object from the current [Activity](xref:botframework-schema.Activity).
|
| 18 | *
|
| 19 | * @param activity The current [Activity](xref:botframework-schema.Activity).
|
| 20 | * @returns The current [Activity](xref:botframework-schema.Activity)'s team meeting info, or null.
|
| 21 | */
|
| 22 | export declare function teamsGetTeamMeetingInfo(activity: Activity): TeamsMeetingInfo | null;
|
| 23 | /**
|
| 24 | * Gets the TenantInfo object from the current [Activity](xref:botframework-schema.Activity).
|
| 25 | *
|
| 26 | * @param activity The current [Activity](xref:botframework-schema.Activity).
|
| 27 | * @returns The current [Activity](xref:botframework-schema.Activity)'s tenant info, or null.
|
| 28 | */
|
| 29 | export declare function teamsGetTenant(activity: Activity): TenantInfo | null;
|
| 30 | /**
|
| 31 | * Gets the TeamsInfo object from the current [Activity](xref:botframework-schema.Activity).
|
| 32 | *
|
| 33 | * @param activity The current [Activity](xref:botframework-schema.Activity).
|
| 34 | * @returns The current [Activity](xref:botframework-schema.Activity)'s team's info, or null.
|
| 35 | */
|
| 36 | export declare function teamsGetTeamInfo(activity: Activity): TeamInfo | null;
|
| 37 | /**
|
| 38 | * Gets the Team Id from the current [Activity](xref:botframework-schema.Activity).
|
| 39 | *
|
| 40 | * @param activity The current [Activity](xref:botframework-schema.Activity).
|
| 41 | * @returns The current [Activity](xref:botframework-schema.Activity)'s team's Id, or null.
|
| 42 | */
|
| 43 | export declare function teamsGetTeamId(activity: Activity): string | null;
|
| 44 | /**
|
| 45 | * Activity helper methods for Teams.
|
| 46 | *
|
| 47 | * @param activity The current [Activity](xref:botframework-schema.Activity).
|
| 48 | * @returns The current [Activity](xref:botframework-schema.Activity)'s team's channel id, or null.
|
| 49 | */
|
| 50 | export declare function teamsGetChannelId(activity: Activity): string | null;
|
| 51 | /**
|
| 52 | * Configures the current [Activity](xref:botframework-schema.Activity) to generate a notification within Teams.
|
| 53 | *
|
| 54 | * @param activity The current [Activity](xref:botframework-schema.Activity).
|
| 55 | * @param alertInMeeting Sent to a meeting chat, this will cause the Teams client to render it in a notification popup as well as in the chat thread.
|
| 56 | * @param externalResourceUrl Url to external resource. Must be included in manifest's valid domains.
|
| 57 | */
|
| 58 | export declare function teamsNotifyUser(activity: Partial<Activity>, alertInMeeting?: boolean, externalResourceUrl?: string): void;
|
| 59 | /**
|
| 60 | * @param activity The current [Activity](xref:botframework-schema.Activity).
|
| 61 | * @returns The current [Activity](xref:botframework-schema.Activity)'s team's onBehalfOf list, or null.
|
| 62 | */
|
| 63 | export declare function teamsGetTeamOnBehalfOf(activity: Activity): OnBehalfOf[];
|
| 64 | //# sourceMappingURL=teamsActivityHelpers.d.ts.map |
| \ | No newline at end of file |