Home Reference Source
import ProfileInfo from 'magister.js/src/profileInfo.js'
public class | source

ProfileInfo

Extends:

MagisterThing → ProfileInfo

Member Summary

Public Members
public
public
public
public
public
public
public
public

undefined when this.isChild is false.

public
public
public
public
public

Method Summary

Public Methods
public
public

getFullName(useBirthname: Boolean): String

public

getProfilePicture(width: Number, height: Number, crop: Boolean): Promise<Stream>

Opens a stream to the profile picture of the current user with the given options.

public

Inherited Summary

From class MagisterThing
public

Public Members

public birthDate: Date source

public birthNamePrefix: String source

public birthSurname: String source

public firstName: String source

public id: String source

public initials: String source

public isChild: Boolean source

public isVisibleForParent: Boolean | undefined source

undefined when this.isChild is false.

public lastName: String source

public namePrefix: String source

public officialFirstNames: String source

public officialSurname: String source

public useBirthname: Boolean source

Public Methods

public address(): Promise<Error|AddressInfo> source

public getFullName(useBirthname: Boolean): String source

Params:

NameTypeAttributeDescription
useBirthname Boolean
  • optional
  • default: this.useBirthname

Return:

String

public getProfilePicture(width: Number, height: Number, crop: Boolean): Promise<Stream> source

Opens a stream to the profile picture of the current user with the given options.

Params:

NameTypeAttributeDescription
width Number
  • optional
  • default: 640

The width of the picture.

height Number
  • optional
  • default: 640

The height of the picture.

crop Boolean
  • optional
  • default: false

Whether or not to crop the image.

Return:

Promise<Stream>