import User from '@npr/npr-one-sdk/model/user.js'

public class | source

User

Extends:

CollectionDoc → User

Container class for all metadata pertaining to a user object from the NPR One API

Test:

User

Constructor Summary

Public Constructor
public	constructor(json: CollectionDocJSON)

Member Summary

Public Members
public	attributes: UserAttributes

Method Summary

Public Methods
public	getAffiliations(): Array<UserAffiliation> Returns the programs, shows, and podcasts that this user has positively interacted with.
public	getCohort(): UserCohort Returns the user's cohort. In most cases, SDK consumers will never need to use this.
public	getOrganizations(): Array<UserOrganization> Returns the list of organizations this user is affiliated with.
public	getPrimaryOrganization(): null \| UserOrganization Returns the primary, non-NPR organization that this user is affiliated with, or null if no such organization exists.
public	isTemporary(): boolean Whether this user is a temporary user or not
public	toString(): string A convenience function to cast this object back to a string, generally only used by the Logger class.

Inherited Summary

From class CollectionDoc
public get	collectionDoc: CollectionDocJSON Exposed for legacy reasons.
protected	_raw: Object
protected	_validate() Ensure that the given Collection Doc is valid

Public Constructors

public constructor(json: CollectionDocJSON) source

Override:

CollectionDoc#constructor

Params:

Name	Type	Attribute	Description
json	CollectionDocJSON		The decoded JSON object that should be used as the basis for this model

Test:

User constructor

Public Members

public attributes: UserAttributes source

Public Methods

public getAffiliations(): Array<UserAffiliation> source

Returns the programs, shows, and podcasts that this user has positively interacted with.

Return:

Array<UserAffiliation>

Test:

User getAffiliations

public getCohort(): UserCohort source

Returns the user's cohort. In most cases, SDK consumers will never need to use this.

Return:

UserCohort

Test:

User getCohort

public getOrganizations(): Array<UserOrganization> source

Returns the list of organizations this user is affiliated with. In most cases, you only want a single organization, in which case User#getPrimaryOrganization should be used.