@veltdev/types
Version:
Velt is an SDK to add collaborative features to your product within minutes. Example: Comments like Figma, Frame.io, Google docs or sheets, Recording like Loom, Huddles like Slack and much more.
51 lines (50 loc) • 1.2 kB
TypeScript
export declare class UserContact {
/**
* Unique user identifier that you use to identify your user.
*/
userId: string;
/**
* Your user's full name.
*
* Default: Random avatar name.
*/
name?: string;
/**
* Your user's display picture URL.
*
* Default: Random avatar image.
*/
photoUrl?: string;
/**
* This is required if you want us to send email or slack notifications
* to users when they add comments and tag their co-workers.
*/
email: string;
/**
* It could be a domain name or any identifier you use to cluster a group of users who work together.
*/
groupId?: string;
source?: string;
visibility: 'group' | 'private';
color?: string;
textColor?: string;
initial?: string;
}
export declare class SelectedUserContact {
/**
* Selected user contact details.
*/
contact: UserContact;
/**
* Is user part of organization contact.
*/
isOrganizationContact: boolean;
/**
* Is user part of document contact.
*/
isDocumentContact: boolean;
/**
* Document access type.
*/
documentAccessType: string;
}