Skip to content

profile.md

Latest commit

 

History

History
51 lines (39 loc) · 1.84 KB

profile.md

File metadata and controls

51 lines (39 loc) · 1.84 KB

Profile API

When a user is created, a profile is also automatically generated. The application can store user specific information in the profile.

Querying the user's profile

sdk.profile.getMyProfile()
    .then(function (profile) {
        console.log("getMyProfile() succeeded", profile);
    })
    .catch(function (error) {
        console.error("getMyProfile() failed", error);
    });

Updating the user's profile

Note, this will overwrite the existing profile - if you want to modify a subset of the user's profile, please used the patch function.

sdk.services.profile.updateMyProfile(profile)
    .then(function (updatedProfile) {
        console.error("updateMyProfile() succeeded", updatedProfile);
    })
    .catch(function (error) {
        console.error("updateMyProfile() failed", error);
    });

Patching the user's profile

Patching has the effect of merging the existing profile with the data supplied in the patch call.

sdk.services.profile.patchMyProfile(data)
    .then(function (updatedProfile) {
        console.error("patchMyProfile() succeeded", updatedProfile);
    })
    .catch(function (error) {
        console.error("patchMyProfile() failed", error);
    });

eTags

The SDK internally uses eTags to prevent simultaneous updates of the profile from overwriting each other.

If you want to update a profile, you need to query it first, make the appropriate changes to it and then update it. When the profile is queried, an eTag is internally stored and passed back in the update. If they don't match, an error will be returned. This means that the state of the profile has changed since it was queried and what we tried to update is now stale.

For more info on where eTags are used in the Comapi SDK, please see this section