AuthenticateParameters interface

Package:

@microsoft/teams-js

Properties

failureCallback	A function that is called if the authentication fails, with the reason for the failure returned from the authentication pop-up.
height	The preferred height for the pop-up. This value can be ignored if outside the acceptable bounds.
isExternal	The flag which indicates whether the auth page should be opened in an external browser. This flag has no effect on the web client.
successCallback	A function that is called if the authentication succeeds, with the result returned from the authentication pop-up.
url	The URL for the authentication pop-up.
width	The preferred width for the pop-up. This value can be ignored if outside the acceptable bounds.

Property Details

failureCallback

A function that is called if the authentication fails, with the reason for the failure returned from the authentication pop-up.

failureCallback?: (reason?: string) => void

Property Value

(reason?: string) => void

height

The preferred height for the pop-up. This value can be ignored if outside the acceptable bounds.

height?: number

Property Value

number

isExternal

The flag which indicates whether the auth page should be opened in an external browser. This flag has no effect on the web client.

isExternal?: boolean

Property Value

boolean

successCallback

A function that is called if the authentication succeeds, with the result returned from the authentication pop-up.

successCallback?: (result?: string) => void

Property Value

(result?: string) => void

url

The URL for the authentication pop-up.

url: string

Property Value

string

width

The preferred width for the pop-up. This value can be ignored if outside the acceptable bounds.

width?: number

Property Value

number