Index
Functions
add User Profile Event Listener
Parameters
userProfileEvent: UserProfileEvent
listenerFn: ListenerFn<UserProfileEvent, IBlockInfo>
Returns void
Const create User Profile
Creates user profile. If no nickname argument is passed, a random nickname will be generated.
Parameters
args: { nickname?: string }
Optional nickname?: string
Optional nickname
Returns Promise<IUserProfile>
Const get User Profile
Gets userProfile from accessToken.
Parameters
args: { accessToken?: string; profileId?: string }
Optional access
Token?: string Optional profile
Id?: string
Returns Promise<IUserProfile>
remove User Profile Event Listener
Parameters
userProfileEvent: UserProfileEvent
Optional listenerFn: ListenerFn<UserProfileEvent, IBlockInfo>
Returns void
Const update User Profile
Updates profile by accessToken with optional changed nickname or custom_data.
Parameters
args: { accessToken: string; options?: { custom_data?: string; nickname?: string } }
access
Token: string userProfile access_token
Optional options?: { custom_data?: string; nickname?: string }
Optional custom_
data?: string Data saved to profile's custom_data property
Optional nickname?: string
The nickname to update the userProfile
Returns Promise<IUserProfile>
Generated using TypeDoc
Add listener for the given UserProfileEvent
2.13.0