Interface: UserInfoProvider

Interfaces to retrieve User profile related information.

Hierarchy

▸ getAccessToken(audience: string, scopes: string[]): Promise<AccessTokenData | MiniAppError>

Fetches the access token from host app.

Name	Type	Description
`audience`	string	one of the audiences provided in MiniApp manifest
`scopes`	string[]	scopes array associated to the audience

Returns: Promise<AccessTokenData | MiniAppError>

Access token from native host app.

▸ getContacts(): Promise<Contact[]>

Fetches the contact list from host app. You should request the CustomPermissionName.CONTACT_LIST permission before using this method.

Returns: Promise<Contact[]>

Contact list in the host app user profile.

▸ getPhoneNumber(): Promise<string>

Fetches the Phone number of the user.

Returns: Promise<string>

Phone number saved in the host app user profile.

▸ getPoints(): Promise<Points>

Fetches the points from host app.

Returns: Promise<Points>

Points from native host app.

▸ getProfilePhoto(): Promise<string>

Fetches the profile photo URI from host app. You should request the CustomPermissionName.PROFILE_PHOTO permission before using this method.

Returns: Promise<string>

Profile photo saved in the host app user profile.

▸ getUserName(): Promise<string>

Fetches the username from host app. You should request the CustomPermissionName.USER_NAME permission before using this method.

Returns: Promise<string>

Username saved in the host app user profile.