User
Defined in: src/models/user.model.ts:9
User model wrapping a validated Notion user object with helper methods.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new User(
data):User
Defined in: src/models/user.model.ts:10
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”User
Overrides
Section titled “Overrides”BaseModel<NotionUser>.constructor
Accessors
Section titled “Accessors”avatarUrl
Section titled “avatarUrl”Get Signature
Section titled “Get Signature”get avatarUrl():
string|null|undefined
Defined in: src/models/user.model.ts:30
Returns
Section titled “Returns”string | null | undefined
Get Signature
Section titled “Get Signature”get id():
string
Defined in: src/models/user.model.ts:18
Returns the unique identifier.
Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”Get Signature
Section titled “Get Signature”get name():
string|undefined
Defined in: src/models/user.model.ts:26
Returns
Section titled “Returns”string | undefined
object
Section titled “object”Get Signature
Section titled “Get Signature”get object():
string
Defined in: src/models/user.model.ts:14
Returns the object type, for example “page”, “block”, or “user”.
Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”Get Signature
Section titled “Get Signature”get type():
"person"|"bot"|undefined
Defined in: src/models/user.model.ts:22
Returns
Section titled “Returns”"person" | "bot" | undefined
Methods
Section titled “Methods”getBotInfo()
Section titled “getBotInfo()”getBotInfo(): {
owner: {type:"workspace";workspace:true; } | {type:"user"; };workspace_id?:string;workspace_limits?: {max_file_upload_size_in_bytes:number; };workspace_name?:string|null; } |undefined
Defined in: src/models/user.model.ts:61
Get bot information if this is a bot user.
Returns
Section titled “Returns”{ owner: { type: "workspace"; workspace: true; } | { type: "user"; }; workspace_id?: string; workspace_limits?: { max_file_upload_size_in_bytes: number; }; workspace_name?: string | null; } | undefined
getEmail()
Section titled “getEmail()”getEmail():
string|undefined
Defined in: src/models/user.model.ts:51
Get email if this is a person user.
Returns
Section titled “Returns”string | undefined
isBot()
Section titled “isBot()”isBot(): this is User & { data: { avatar_url?: string | null; bot: { owner: { type: “workspace”; workspace: true } | { type: “user” }; workspace_id?: string; workspace_limits?: { max_file_upload_size_in_bytes: number }; workspace_name?: string | null }; id: string; name?: string; object: “user”; type: “bot” } }
Defined in: src/models/user.model.ts:44
Check if this is a bot user.
Returns
Section titled “Returns”this is User & { data: { avatar_url?: string | null; bot: { owner: { type: “workspace”; workspace: true } | { type: “user” }; workspace_id?: string; workspace_limits?: { max_file_upload_size_in_bytes: number }; workspace_name?: string | null }; id: string; name?: string; object: “user”; type: “bot” } }
isPerson()
Section titled “isPerson()”isPerson(): this is User & { data: { avatar_url?: string | null; id: string; name?: string; object: “user”; person: { email: string; email_verified?: boolean }; type: “person” } }
Defined in: src/models/user.model.ts:37
Check if this is a person user.
Returns
Section titled “Returns”this is User & { data: { avatar_url?: string | null; id: string; name?: string; object: “user”; person: { email: string; email_verified?: boolean }; type: “person” } }
toJSON()
Section titled “toJSON()”toJSON(): {
avatar_url?:string|null;id:string;name?:string;object:"user";person: {string;email_verified?:boolean; };type:"person"; } | {avatar_url?:string|null;bot: {owner: {type:"workspace";workspace:true; } | {type:"user"; };workspace_id?:string;workspace_limits?: {max_file_upload_size_in_bytes:number; };workspace_name?:string|null; };id:string;name?:string;object:"user";type:"bot"; } | {id:string;object:"user"; }
Defined in: src/models/base.model.ts:20
Returns the raw validated data as a plain object.
Returns
Section titled “Returns”{ avatar_url?: string | null; id: string; name?: string; object: "user"; person: { email: string; email_verified?: boolean; }; type: "person"; } | { avatar_url?: string | null; bot: { owner: { type: "workspace"; workspace: true; } | { type: "user"; }; workspace_id?: string; workspace_limits?: { max_file_upload_size_in_bytes: number; }; workspace_name?: string | null; }; id: string; name?: string; object: "user"; type: "bot"; } | { id: string; object: "user"; }