View on GitHub
UserProfileUploadData Structure Reference
UserProfileUploadData
public struct UserProfileUploadData : Contentextension UserProfileUploadData: RCFValidatableUsed to edit the current user’s profile contents. For profile data on users, see ProfilePublicData.
Required by:
POST /api/v3/user/profile
Returned by:
GET /api/v3/user/profilePOST /api/v3/user/profile
See UserController.profileHandler(_:), UserController.profileUpdateHandler(_:data:).
-
Basic info about the user–their ID, username, displayname, and avatar image. May be nil on POST.
Declaration
Swift
var header: UserHeader? -
The displayName, again. Will be equal to header.displayName in results. When POSTing, set this field to update displayName.
Declaration
Swift
var displayName: String? -
An optional real name of the user.
Declaration
Swift
var realName: String? -
An optional preferred form of address.
Declaration
Swift
var preferredPronoun: String? -
An optional home location (e.g. city).
Declaration
Swift
var homeLocation: String? -
An optional ship cabin number.
Declaration
Swift
var roomNumber: String? -
An optional email address.
Declaration
Swift
var email: String? -
An optional short greeting/message to visitors of the profile.
Declaration
Swift
var message: String? -
An optional blurb about the user.
Declaration
Swift
var about: String? -
An optional dinner team assignment.
Declaration
Swift
var dinnerTeam: DinnerTeam? -
Declaration
Swift
init(user: User) throws -
Declaration
Swift
func runValidations(using decoder: ValidatingDecoder) throws