@salad-labs/loopz-typescript
Version:
The Official Loopz TypeScript SDK
84 lines • 2.96 kB
TypeScript
import { Chat } from "../../..";
import { Maybe } from "../../../types/base";
/**
* Interface representing the schema for a conversation.
* @interface ConversationSchema
*/
export interface ConversationSchema {
/**
* @property {string} id - The unique identifier for the conversation.
*/
id: string;
/**
* @property {string} name - The name of the conversation.
*/
name: string;
/**
* @property {Maybe<string>} description - The description of the conversation.
*/
description: Maybe<string>;
/**
* @property {Maybe<string>} imageURL - The URL of the image associated with the conversation.
*/
imageURL: Maybe<string>;
/**
* @property {Maybe<string>} bannerImageURL - The URL of the banner image associated with the conversation.
*/
bannerImageURL: Maybe<string>;
/**
* @property {Maybe<string>} imageSettings - The images property of the conversation (bannerImage and image).
*/
imageSettings: Maybe<string>;
/**
* @property {Maybe<string>} settings - Additional settings for the conversation.
*/
settings: Maybe<string>;
/**
* @property {Maybe<Array<string>>} membersIds - An array of member IDs in the conversation.
*/
membersIds: Maybe<Array<string>>;
/**
* @property {Maybe<Array<{userId: string, createdAt: Date}>>} mutedBy - An array of member IDs in the conversation.
*/
mutedBy: Maybe<Array<{
userId: string;
createdAt: Date;
}>>;
/**
* @property {GROUP | ONE_TO_ONE | COMMUNITY | PUBLIC} type - Represents a message type which can be one of "GROUP", "ONE_TO_ONE", or "COMMUNITY".
*/
type: "GROUP" | "ONE_TO_ONE" | "COMMUNITY" | "PUBLIC";
/**
* @property {Maybe<Date>} lastMessageSentAt - The date when the message was last sent, if available.
*/
lastMessageSentAt: Maybe<Date>;
/**
* @property {Maybe<string>} ownerId - The ID of the message owner, if available.
*/
ownerId: Maybe<string>;
/**
* @property {Maybe<string>} publicConversationAESKey - The public AES key of the conversation, if available.
*/
publicConversationAESKey: Maybe<string>;
/**
* @property {Maybe<string>} publicConversationIVKey - The public IV key of the conversation, if available.
*/
publicConversationIVKey: Maybe<string>;
/**
* @property {Date} createdAt - The date when the message was created.
*/
createdAt: Date;
/**
* @property {Maybe<Date>} updatedAt - The date when the message was last updated, if available.
*/
updatedAt: Maybe<Date>;
/**
* @property {Maybe<Date>} deletedAt - The date when the message was deleted, if available.
*/
deletedAt: Maybe<Date>;
/**
* @property {Chat} chatParent -The chat parent object that has generated this object.
*/
chatParent: Chat;
}
//# sourceMappingURL=conversation.d.ts.map