Method GetUserSettings

GetUserSettings()

Gets information about a user's Halo Waypoint settings.

Declaration

public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.Waypoint.UserSettings,Den.Dev.Grunt.Models.RawResponseContainer>> GetUserSettings ();

Returns

Type	Description
System.Threading.Tasks.Task<HaloApiResultContainer<UserSettings,RawResponseContainer>>	If successful, returns an instance of UserSettings containing user configuration information. Otherwise, returns a null object and error details.

Remarks

Settings are obtained for the user associated with the Spartan token passed to the request.

Examples

Here is an example response from the API, as snapshotted on 10/11/2022:

   {
       "xuid": "0000000000000000",
       "email": {
           "emailAddress": "[email protected]",
           "verified": true
       },
       "notifications": {
           "insider": false
       }
   }