Interface: NotesApi

Notes: the short text over a profile picture in the inbox.

Methods

create()

create(text, options?): Promise<{
[key: string]: unknown;
  audience?: number;
  author?: {
   [key: string]: unknown;
     biography?: string;
     external_url?: string | null;
     follower_count?: number | null;
     following_count?: number | null;
     full_name?: string;
     is_private?: boolean;
     is_verified?: boolean;
     media_count?: number | null;
     pk?: string;
     profile_pic_url?: string | null;
     username?: string;
  };
  author_id?: string;
  created_at?: number;
  expires_at?: number;
  is_emoji_only?: boolean;
  note_id: string;
  note_style?: number;
  text?: string;
}>;

Posts a note (1 to 60 characters), for mutual followers or close friends.

Parameters

Parameter	Type
text	string
options?	CreateNoteOptions

Returns

Promise<{ [key: string]: unknown; audience?: number; author?: { [key: string]: unknown; biography?: string; external_url?: string | null; follower_count?: number | null; following_count?: number | null; full_name?: string; is_private?: boolean; is_verified?: boolean; media_count?: number | null; pk?: string; profile_pic_url?: string | null; username?: string; }; author_id?: string; created_at?: number; expires_at?: number; is_emoji_only?: boolean; note_id: string; note_style?: number; text?: string; }>

---

delete()

delete(noteId): Promise<void>;

Deletes a note by its id.

Parameters

Parameter	Type
noteId	string

Returns

Promise<void>

---

list()

list(): Promise<object[]>;

The notes in the inbox tray: the account's own and those of followed accounts.

Returns

Promise<object[]>