sharing module
Module to open a share dialog for web content. For more info, see Share to Teams from personal app or tab
Interfaces
| IFileContent |
Represents IFileContent parameters. |
| IShareRequest |
Represents IShareRequest parameters interface. |
| IURLContent |
Represents IURLContent parameters. |
Type Aliases
| IShareRequestContentType |
IShareRequestContentType defines share request type. |
| shareWebContentCallbackFunctionType |
shareWebContent callback function type |
Functions
| is |
Checks if the sharing capability is supported by the host |
| share |
Feature is under development Opens a share dialog for web content |
| share |
Variables
| Sharing |
Type of message that can be sent or received by the sharing APIs |
Function Details
isSupported()
Checks if the sharing capability is supported by the host
function isSupported(): booleanReturns
boolean
boolean to represent whether the sharing capability is supported
shareWebContent(IShareRequest<IShareRequestContentType>)
Feature is under development Opens a share dialog for web content
function shareWebContent(shareWebContentRequest: IShareRequest<IShareRequestContentType>): Promise<void>Parameters
- shareWebContentRequest
web content info
Returns
Promise<void>
Promise that will be fulfilled when the operation has completed
shareWebContent(IShareRequest<IShareRequestContentType>, shareWebContentCallbackFunctionType)
Warning
This API is now deprecated.
As of TeamsJS v2.0.0, please use sharing.shareWebContent(shareWebContentRequest: IShareRequest<IShareRequestContentType>): Promise<void> instead.
Feature is under development Opens a share dialog for web content
function shareWebContent(shareWebContentRequest: IShareRequest<IShareRequestContentType>, callback: shareWebContentCallbackFunctionType)Parameters
- shareWebContentRequest
web content info
- callback
- shareWebContentCallbackFunctionType
optional callback
Variable Details
SharingAPIMessages
Type of message that can be sent or received by the sharing APIs
SharingAPIMessages: {}Type
{}