diff --git a/app/sdk/README.md b/app/sdk/README.md index 243d579f..eff27cf8 100644 --- a/app/sdk/README.md +++ b/app/sdk/README.md @@ -194,6 +194,29 @@ Automate allocates the Bot interface for ia specific communication channel +
+ Identity interface module manages the account profile
+ + The text details of the profile are set with setProfileData + + ```Identity::setProfileData(name: string, location: string, description: string): Promise``` + + The profile image is set with setProfileImage + + ```Identity::setProfileImage(image: string): Promise``` + + A direct url to retrieve the profile image is provided with getProfileImageUrl + + ```Identity:::getProfileImageUrl(): string``` + + The current profile can be access with a profile listener + + ```Identity::addProfileListener(ev: (profile: Profile) => void): void``` + ```Identity::removeProfileListener(ev: (profile: Profile) => void): void``` + +
+
+ ## Admin Communication ## Bot Communication