95 lines
2.5 KiB
TypeScript
95 lines
2.5 KiB
TypeScript
import Node from './Node';
|
|
export declare type AccountData = {
|
|
birthday: number;
|
|
email: string;
|
|
firstName: string;
|
|
gender: 'male' | 'female' | 'other';
|
|
lastName: string;
|
|
};
|
|
/**
|
|
* Specific type of node for members of the loop. All nodes returned by LoopModel should be UserNodes.
|
|
*
|
|
* @class UserNode
|
|
* @extends jibo.kb.Node
|
|
* @memberof jibo.kb.loop
|
|
*/
|
|
export default class UserNode extends Node {
|
|
data: {
|
|
account: AccountData;
|
|
birthday: number;
|
|
email: string;
|
|
enrolled: {
|
|
voice: boolean;
|
|
face: boolean;
|
|
};
|
|
facebookConnected: boolean;
|
|
firstName: string;
|
|
gender: 'male' | 'female' | 'other';
|
|
isActive: boolean;
|
|
lastName: string;
|
|
loopId: string;
|
|
memberId: string;
|
|
phoneticName: string;
|
|
photoUrl: string;
|
|
nickName: string;
|
|
status: string;
|
|
type: string;
|
|
};
|
|
/**
|
|
* UUID of the user.
|
|
* @name jibo.kb.loop.UserNode#id
|
|
* @type {String}
|
|
*/
|
|
readonly id: string;
|
|
/**
|
|
* First name of the user.
|
|
* @name jibo.kb.loop.UserNode#firstName
|
|
* @type {String}
|
|
*/
|
|
readonly firstName: string;
|
|
/**
|
|
* Last name of the user.
|
|
* @name jibo.kb.loop.UserNode#lastName
|
|
* @type {String}
|
|
*/
|
|
readonly lastName: string;
|
|
/**
|
|
* Nickname of the user.
|
|
* @name jibo.kb.loop.UserNode#nickName
|
|
* @type {String}
|
|
*/
|
|
readonly nickName: string;
|
|
/**
|
|
* Gender of the user.
|
|
* @name jibo.kb.loop.UserNode#gender
|
|
* @type {String}
|
|
*/
|
|
readonly gender: "male" | "female" | "other";
|
|
/**
|
|
* If this loop member is actually Jibo.
|
|
* @name jibo.kb.loop.UserNode#isJibo
|
|
* @type {Boolean}
|
|
*/
|
|
readonly isJibo: boolean;
|
|
/**
|
|
* The loop member's preferred written name. This will be the nickname or first name
|
|
* of the loop member.
|
|
* @method jibo.kb.loop.UserNode#getWrittenName
|
|
* @return {String} The loop member's preferred written name.
|
|
*/
|
|
getWrittenName(): string;
|
|
/**
|
|
* The loop member's preferred spoken name. This will be the `phoneticName`, nickname, or first name
|
|
* of the loop member.
|
|
* @method jibo.kb.loop.UserNode#toString
|
|
* @return {String} The loop member's preferred spoken name.
|
|
*/
|
|
toString(): string;
|
|
/**
|
|
* Calculate the initials of the loop member.
|
|
* @method jibo.kb.loop.UserNode#getInitials
|
|
* @return {String} The loop member's initials.
|
|
*/
|
|
getInitials(): string;
|
|
}
|