Type Alias: IMessage

type IMessage = object;

Defined in: types/api.base.ts:900

Properties

author?

optional author?: IUserSimple | null;

Defined in: types/api.base.ts:937

---

channelId

channelId: number;

Defined in: types/api.base.ts:923

---

content

content: string;

Defined in: types/api.base.ts:925

---

createdAt

createdAt: TimeStampEpochMsec;

Defined in: types/api.base.ts:926

---

createdBy

createdBy: number | null;

Defined in: types/api.base.ts:924

---

forwardedFrom?

optional forwardedFrom?: IMessageReference | null;

Defined in: types/api.base.ts:950

---

forwardedFromMessageId?

optional forwardedFromMessageId?: number | null;

Defined in: types/api.base.ts:949

---

guid

guid: string;

Defined in: types/api.base.ts:922

---

hiddenAt?

optional hiddenAt?: string | null;

Defined in: types/api.base.ts:958

---

hiddenReason?

optional hiddenReason?: MessageHiddenReason | null;

Defined in: types/api.base.ts:957

Set when the message is hidden: still in the log, but shown collapsed until someone chooses to reveal it. ban - its author was banned and their messages hidden with it.

---

id

id: number;

Defined in: types/api.base.ts:921

---

invite?

optional invite?: IMessageServerInvite | null;

Defined in: types/api.base.ts:963

---

inviteServerId?

optional inviteServerId?: number | null;

Defined in: types/api.base.ts:961

---

inviteStatus?

optional inviteStatus?: ServerInviteStatus | null;

Defined in: types/api.base.ts:962

---

isEdited?

optional isEdited?: boolean;

Defined in: types/api.base.ts:928

---

isFailed?

optional isFailed?: boolean;

Defined in: types/api.base.ts:970

---

isPending?

optional isPending?: boolean;

Defined in: types/api.base.ts:969

---

isUrgent?

optional isUrgent?: boolean;

Defined in: types/api.base.ts:934

Sent with /!. Recipients are reminded about it until they read it, so it stays true after the fact - "was urgent", not "is still outstanding".

---

media?

optional media?: IMedia[];

Defined in: types/api.base.ts:939

---

mentionDirectUserIds?

optional mentionDirectUserIds?: number[] | null;

Defined in: types/api.base.ts:912

Why each member of mentionUserIds is in it, so a member can turn off

Everyone

or

Role

notifications without turning off being named. Only mentions that took effect are recorded: an

Everyone

from someone without mention_everyone is not. All three are absent on messages sent before they were recorded, which count every member of the audience as named.

---

mentionEveryone?

optional mentionEveryone?: boolean;

Defined in: types/api.base.ts:914

---

mentionRoleUserIds?

optional mentionRoleUserIds?: number[] | null;

Defined in: types/api.base.ts:913

---

mentionUserIds?

optional mentionUserIds?: number[] | null;

Defined in: types/api.base.ts:904

null/absent means ordinary messaging; an array is the server-resolved mention audience.

---

poll?

optional poll?: IMessagePoll | null;

Defined in: types/api.base.ts:966

---

reactions?

optional reactions?: IMessageReaction[];

Defined in: types/api.base.ts:942

---

replyTo?

optional replyTo?: IMessageReference | null;

Defined in: types/api.base.ts:946

---

replyToMessageId?

optional replyToMessageId?: number | null;

Defined in: types/api.base.ts:945

---

serverId?

optional serverId?: number | null;

Defined in: types/api.base.ts:920

The server the message was posted in, or null for a direct message. Set on messages delivered live, so a client can apply that server's notification settings to a message from a server whose channels it has not loaded.

---

systemType?

optional systemType?: "member_joined" | "calendar_event_reminder" | null;

Defined in: types/api.base.ts:902

A server-generated event, with no user author.

---

updatedAt

updatedAt: TimeStampEpochMsec;

Defined in: types/api.base.ts:927