Merge pull request #318 from matrix-org/hs/ensure-profile

Add Intent.ensureProfile
matrix-org · Mar 25, 2021 · 6831acc · 6831acc
2 parents 6046d31 + 4ec78dc
commit 6831acc
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/changelog.d/318.feature b/changelog.d/318.feature
@@ -0,0 +1 @@
+Add `intent.ensureProfile` function.
diff --git a/src/components/intent.ts b/src/components/intent.ts
@@ -625,6 +625,25 @@ export class Intent {
         return this.client.setAvatarUrl(url);
     }
 
+    /**
+     * Ensure that the user has the given profile information set. If it does not,
+     * set it.
+     * @param displayname The displayname to set. Leave undefined to ignore.
+     * @param avatarUrl The avatar to set. Leave undefined to ignore.
+     */
+    public async ensureProfile(displayname?: string, avatarUrl?: string) {
+        if (!displayname && !avatarUrl) {
+            throw Error('At least one of displayname,avatarUrl must be defined');
+        }
+        const profile = await this.getProfileInfo(this.userId, null, false);
+        if (displayname && profile.displayname !== displayname) {
+            await this.setDisplayName(displayname);
+        }
+        if (avatarUrl && profile.avatar_url !== avatarUrl) {
+            await this.setAvatarUrl(avatarUrl);
+        }
+    }
+
     public async setRoomUserProfile(roomId: string, profile: UserProfile) {
         const userId = this.client.getUserId();
         const currProfile = this.opts.backingStore.getMemberProfile(roomId, userId);