-
Notifications
You must be signed in to change notification settings - Fork 6
/
secondaryBrowser.yml
53 lines (48 loc) · 1.71 KB
/
secondaryBrowser.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
### YamlMime:TSPackage
uid: '@microsoft/teams-js.secondaryBrowser'
name: secondaryBrowser
type: module
package: '@microsoft/teams-js'
summary: |-
Namespace to power up the in-app browser experiences in the host app.
For e.g., opening a URL in the host app inside a browser
previewState: beta
functions:
- name: isSupported()
uid: '@microsoft/teams-js.secondaryBrowser.isSupported'
package: '@microsoft/teams-js'
summary: Checks if secondaryBrowser capability is supported by the host
remarks: ''
previewState: beta
isDeprecated: false
syntax:
content: 'function isSupported(): boolean'
return:
description: boolean to represent whether secondaryBrowser is supported
type: boolean
- name: open(URL)
uid: '@microsoft/teams-js.secondaryBrowser.open'
package: '@microsoft/teams-js'
summary: >-
Open a URL in the secondary browser.
On mobile, this is the in-app browser.
On web and desktop, please use the `window.open()` method or other native
external browser methods.
remarks: >-
Any error that happens after navigation begins is handled by the platform
browser component and not returned from this function.
previewState: beta
isDeprecated: false
syntax:
content: 'function open(url: URL): Promise<void>'
parameters:
- id: url
type: URL
description: Url to open in the browser
return:
description: >-
Promise that successfully resolves if the URL opens in the
secondaryBrowser
or throws an error [SdkError](xref:@microsoft/teams-js.SdkError)
incase of failure before starting navigation
type: Promise<void>