nexus-fca 1.0.0

package/docs/editMessage.md

@@ -0,0 +1,16 @@
+# editMessage
+
+Edit a message by ID.
+
+## Usage
+```js
+api.editMessage('New text', 'mid.$cAA...', (err) => {
+  if (err) return console.error(err);
+  console.log('Message edited!');
+});
+```
+
+## Arguments
+- `text`: New message text (string).
+- `messageID`: Message ID (string).
+- `callback(err)`: Callback called when the operation is done (error or null).

package/docs/follow.md

@@ -0,0 +1,15 @@
+# follow
+
+Follow a Facebook user.
+
+## Usage
+```js
+api.follow('1000123456789', (err, res) => {
+  if (err) return console.error(err);
+  console.log('Now following user!', res);
+});
+```
+
+## Arguments
+- `userID`: The user ID to follow (string).
+- `callback(err, res)`: Callback with error or result.

package/docs/forwardAttachment.md

@@ -0,0 +1,16 @@
+# forwardAttachment
+
+Forward an attachment to one or more users.
+
+## Usage
+```js
+api.forwardAttachment('attachmentID', ['10001','10002'], (err) => {
+  if (err) return console.error(err);
+  console.log('Attachment forwarded!');
+});
+```
+
+## Arguments
+- `attachmentID`: The ID of the attachment.
+- `userOrUsers`: User ID or array of user IDs.
+- `callback(err)`: Callback called when the operation is done (error or null).

package/docs/getAccess.md

@@ -0,0 +1,17 @@
+# getAccess
+
+Get your current Facebook access token (advanced usage).
+
+## Usage
+```js
+api.getAccess((err, token) => {
+  if (err) return console.error(err);
+  console.log('Access token:', token);
+});
+```
+
+## Arguments
+- `callback(err, token)`: Callback with error or access token string.
+
+## Safety Note
+Keep your access token private.

package/docs/getAvatarUser.md

@@ -0,0 +1,15 @@
+# getAvatarUser
+
+Get the avatar (profile picture) of a user.
+
+## Usage
+```js
+api.getAvatarUser('1000123456789', (err, url) => {
+  if (err) return console.error(err);
+  console.log('Avatar URL:', url);
+});
+```
+
+## Arguments
+- `userID`: The user ID (string).
+- `callback(err, url)`: Callback with error or avatar URL.

package/docs/getBotInitialData.md

@@ -0,0 +1,14 @@
+# getBotInitialData
+
+Get initial data for the bot session (internal/advanced).
+
+## Usage
+```js
+api.getBotInitialData((err, data) => {
+  if (err) return console.error(err);
+  console.log('Bot initial data:', data);
+});
+```
+
+## Arguments
+- `callback(err, data)`: Callback with error or initial data object.

package/docs/getCtx.md

@@ -0,0 +1,14 @@
+# getCtx
+
+Get the current Facebook context/session info.
+
+## Usage
+```js
+api.getCtx((err, ctx) => {
+  if (err) return console.error(err);
+  console.log('Context:', ctx);
+});
+```
+
+## Arguments
+- `callback(err, ctx)`: Callback with error or context object.

package/docs/getCurrentUserID.md

@@ -0,0 +1,12 @@
+# getCurrentUserID
+
+Get the currently logged-in user's Facebook user ID.
+
+## Usage
+```js
+const userID = api.getCurrentUserID();
+console.log('Current user ID:', userID);
+```
+
+## Returns
+- The user ID (string).

package/docs/getEmojiUrl.md

@@ -0,0 +1,17 @@
+# getEmojiUrl
+
+Get the URL to a Facebook Messenger-style emoji image asset.
+
+## Usage
+```js
+const url = api.getEmojiUrl('😄', 128, 1.5);
+console.log('Emoji URL:', url);
+```
+
+## Arguments
+- `c`: Emoji character (string).
+- `size`: Image size (32, 64, 128).
+- `pixelRatio`: Pixel ratio (1.0 or 1.5).
+
+## Returns
+- URL string for the emoji image.

package/docs/getFriendsList.md

@@ -0,0 +1,14 @@
+# getFriendsList
+
+Get a list of your Facebook friends.
+
+## Usage
+```js
+api.getFriendsList((err, friends) => {
+  if (err) return console.error(err);
+  console.log('Friends:', friends);
+});
+```
+
+## Arguments
+- `callback(err, friends)`: Callback with error or array of friend objects.

package/docs/getMessage.md

@@ -0,0 +1,15 @@
+# getMessage
+
+Get a message by ID (advanced/utility).
+
+## Usage
+```js
+api.getMessage('mid.$cAA...', (err, message) => {
+  if (err) return console.error(err);
+  console.log('Message:', message);
+});
+```
+
+## Arguments
+- `messageID`: The message ID (string).
+- `callback(err, message)`: Callback with error or message object.

package/docs/getOptions.md

@@ -0,0 +1,14 @@
+# getOptions
+
+Get the current Nexus-FCA options.
+
+## Usage
+```js
+api.getOptions((err, options) => {
+  if (err) return console.error(err);
+  console.log('Options:', options);
+});
+```
+
+## Arguments
+- `callback(err, options)`: Callback with error or options object.

package/docs/getRegion.md

@@ -0,0 +1,14 @@
+# getRegion
+
+Get your current Facebook region info.
+
+## Usage
+```js
+api.getRegion((err, region) => {
+  if (err) return console.error(err);
+  console.log('Region:', region);
+});
+```
+
+## Arguments
+- `callback(err, region)`: Callback with error or region string/object.

package/docs/getThreadHistory.md

@@ -0,0 +1,17 @@
+# getThreadHistory
+
+Get message history for a thread.
+
+## Usage
+```js
+api.getThreadHistory('1234567890', 20, undefined, (err, messages) => {
+  if (err) return console.error(err);
+  console.log('Messages:', messages);
+});
+```
+
+## Arguments
+- `threadID`: Thread ID (string).
+- `amount`: Number of messages to fetch (integer).
+- `timestamp`: (Optional) Fetch messages before this timestamp.
+- `callback(err, messages)`: Callback with error or array of messages.

package/docs/getThreadHistoryDeprecated.md

@@ -0,0 +1,17 @@
+# getThreadHistoryDeprecated
+
+Legacy version of thread history retrieval. Use only if the main method does not work for your account.
+
+## Usage
+```js
+api.getThreadHistoryDeprecated(threadID, amount, timestamp, (err, history) => {
+  if (err) return console.error(err);
+  console.log('History:', history);
+});
+```
+
+## Arguments
+- Same as `getThreadHistory`.
+
+## Safety Note
+Deprecated methods may be removed in future versions.

package/docs/getThreadInfo.md

@@ -0,0 +1,15 @@
+# getThreadInfo
+
+Get info about a thread (group or user chat).
+
+## Usage
+```js
+api.getThreadInfo('1234567890', (err, info) => {
+  if (err) return console.error(err);
+  console.log('Thread info:', info);
+});
+```
+
+## Arguments
+- `threadID`: Thread ID (string).
+- `callback(err, info)`: Callback with error or thread info object.

package/docs/getThreadInfoDeprecated.md

@@ -0,0 +1,17 @@
+# getThreadInfoDeprecated
+
+Legacy version of thread info retrieval. Use only if the main method does not work for your account.
+
+## Usage
+```js
+api.getThreadInfoDeprecated(threadID, (err, info) => {
+  if (err) return console.error(err);
+  console.log('Thread info:', info);
+});
+```
+
+## Arguments
+- Same as `getThreadInfo`.
+
+## Safety Note
+Deprecated methods may be removed in future versions.

package/docs/getThreadList.md

@@ -0,0 +1,17 @@
+# getThreadList
+
+Get a list of threads (conversations).
+
+## Usage
+```js
+api.getThreadList(10, null, ['INBOX'], (err, threads) => {
+  if (err) return console.error(err);
+  console.log('Threads:', threads);
+});
+```
+
+## Arguments
+- `limit`: Number of threads to fetch (integer).
+- `timestamp`: (Optional) Fetch threads before this timestamp (null for now).
+- `tags`: Array of tags (e.g. ['INBOX']).
+- `callback(err, threads)`: Callback with error or array of thread objects.

package/docs/getThreadListDeprecated.md

@@ -0,0 +1,17 @@
+# getThreadListDeprecated
+
+Legacy version of thread list retrieval. Use only if the main method does not work for your account.
+
+## Usage
+```js
+api.getThreadListDeprecated(limit, timestamp, tags, (err, list) => {
+  if (err) return console.error(err);
+  console.log('Thread list:', list);
+});
+```
+
+## Arguments
+- Same as `getThreadList`.
+
+## Safety Note
+Deprecated methods may be removed in future versions.

package/docs/getThreadPictures.md

@@ -0,0 +1,17 @@
+# getThreadPictures
+
+Get pictures sent in a thread.
+
+## Usage
+```js
+api.getThreadPictures('1234567890', 0, 10, (err, pictures) => {
+  if (err) return console.error(err);
+  console.log('Pictures:', pictures);
+});
+```
+
+## Arguments
+- `threadID`: Thread ID (string).
+- `offset`: Start index (integer).
+- `limit`: Number of pictures to fetch (integer).
+- `callback(err, pictures)`: Callback with error or array of picture objects.

package/docs/getUID.md

@@ -0,0 +1,15 @@
+# getUID
+
+Get the Facebook user ID from a username.
+
+## Usage
+```js
+api.getUID('zuck', (err, userID) => {
+  if (err) return console.error(err);
+  console.log('User ID:', userID);
+});
+```
+
+## Arguments
+- `username`: The Facebook username (string).
+- `callback(err, userID)`: Callback with error or user ID.

package/docs/getUserID.md

@@ -0,0 +1,15 @@
+# getUserID
+
+Get Facebook user ID(s) from a name or vanity URL.
+
+## Usage
+```js
+api.getUserID('Mark Zuckerberg', (err, users) => {
+  if (err) return console.error(err);
+  console.log('User(s):', users);
+});
+```
+
+## Arguments
+- `name`: Name or vanity URL (string).
+- `callback(err, users)`: Callback with error or array of user objects.

package/docs/getUserInfo.md

@@ -0,0 +1,15 @@
+# getUserInfo
+
+Get information about one or more users.
+
+## Usage
+```js
+api.getUserInfo(['10001','10002'], (err, info) => {
+  if (err) return console.error(err);
+  console.log('User info:', info);
+});
+```
+
+## Arguments
+- `userOrUsers`: User ID or array of user IDs.
+- `callback(err, info)`: Callback with error or user info object.

package/docs/handleFriendRequest.md

@@ -0,0 +1,16 @@
+# handleFriendRequest
+
+Accept or reject a friend request.
+
+## Usage
+```js
+api.handleFriendRequest('1000123456789', true, (err) => {
+  if (err) return console.error(err);
+  console.log('Friend request handled!');
+});
+```
+
+## Arguments
+- `userID`: User ID (string).
+- `accept`: Boolean to accept (true) or reject (false).
+- `callback(err)`: Callback called when the operation is done (error or null).

package/docs/handleMessageRequest.md

@@ -0,0 +1,16 @@
+# handleMessageRequest
+
+Accept or ignore message requests for one or more threads.
+
+## Usage
+```js
+api.handleMessageRequest('1234567890', true, (err) => {
+  if (err) return console.error(err);
+  console.log('Message request handled!');
+});
+```
+
+## Arguments
+- `threadID`: Thread ID or array of thread IDs.
+- `accept`: Boolean to accept (true) or ignore (false).
+- `callback(err)`: Callback called when the operation is done (error or null).

package/docs/httpGet.md

@@ -0,0 +1,15 @@
+# httpGet
+
+Perform a raw HTTP GET request (utility/advanced).
+
+## Usage
+```js
+api.httpGet('https://example.com', (err, res) => {
+  if (err) return console.error(err);
+  console.log('Response:', res);
+});
+```
+
+## Arguments
+- `url`: URL to fetch (string).
+- `callback(err, res)`: Callback with error or response object.

package/docs/httpPost.md

@@ -0,0 +1,16 @@
+# httpPost
+
+Perform a raw HTTP POST request (utility/advanced).
+
+## Usage
+```js
+api.httpPost('https://example.com', { key: 'value' }, (err, res) => {
+  if (err) return console.error(err);
+  console.log('Response:', res);
+});
+```
+
+## Arguments
+- `url`: URL to post to (string).
+- `data`: Data to send (object).
+- `callback(err, res)`: Callback with error or response object.

package/docs/httpPostFormData.md

@@ -0,0 +1,16 @@
+# httpPostFormData
+
+Perform a raw HTTP POST request with form data (utility/advanced).
+
+## Usage
+```js
+api.httpPostFormData('https://example.com', { key: 'value' }, (err, res) => {
+  if (err) return console.error(err);
+  console.log('Response:', res);
+});
+```
+
+## Arguments
+- `url`: URL to post to (string).
+- `formData`: Form data to send (object).
+- `callback(err, res)`: Callback with error or response object.

package/docs/listenMqtt.md

@@ -0,0 +1,17 @@
+# listenMqtt
+
+Listen for new messages and events using the MQTT protocol.
+
+## Usage
+```js
+api.listenMqtt((err, message) => {
+  if (err) return console.error(err);
+  console.log('Received:', message);
+});
+```
+
+## Arguments
+- `callback(err, message)`: Callback with error or message/event object.
+
+## Notes
+- Returns an EventEmitter with a `stopListening()` method.

package/docs/listenNotification.md

@@ -0,0 +1,14 @@
+# listenNotification
+
+Listen for Facebook notifications (advanced, experimental).
+
+## Usage
+```js
+api.listenNotification((err, notification) => {
+  if (err) return console.error(err);
+  console.log('Notification:', notification);
+});
+```
+
+## Arguments
+- `callback(err, notification)`: Callback with error or notification object.

package/docs/logout.md

@@ -0,0 +1,14 @@
+# logout
+
+Log out the current user.
+
+## Usage
+```js
+api.logout((err) => {
+  if (err) return console.error(err);
+  console.log('Logged out!');
+});
+```
+
+## Arguments
+- `callback(err)`: Callback called when the operation is done (error or null).

package/docs/markAsDelivered.md

@@ -0,0 +1,16 @@
+# markAsDelivered
+
+Mark a message as delivered in a thread.
+
+## Usage
+```js
+api.markAsDelivered('1234567890', 'mid.$cAA...', (err) => {
+  if (err) return console.error(err);
+  console.log('Marked as delivered!');
+});
+```
+
+## Arguments
+- `threadID`: Thread ID (string).
+- `messageID`: Message ID (string).
+- `callback(err)`: Callback called when the operation is done (error or null).

package/docs/markAsRead.md

@@ -0,0 +1,16 @@
+# markAsRead
+
+Mark all unread messages in a thread as read.
+
+## Usage
+```js
+api.markAsRead('1234567890', true, (err) => {
+  if (err) return console.error(err);
+  console.log('Marked as read!');
+});
+```
+
+## Arguments
+- `threadID`: Thread ID (string).
+- `read`: (Optional) Boolean to mark as read (true) or unread (false).
+- `callback(err)`: Callback called when the operation is done (error or null).

package/docs/markAsReadAll.md

@@ -0,0 +1,14 @@
+# markAsReadAll
+
+Mark all messages in your inbox as read.
+
+## Usage
+```js
+api.markAsReadAll((err) => {
+  if (err) return console.error(err);
+  console.log('All messages marked as read!');
+});
+```
+
+## Arguments
+- `callback(err)`: Callback called when the operation is done (error or null).

package/docs/markAsSeen.md

@@ -0,0 +1,15 @@
+# markAsSeen
+
+Mark your entire inbox as seen.
+
+## Usage
+```js
+api.markAsSeen(Date.now(), (err) => {
+  if (err) return console.error(err);
+  console.log('Inbox marked as seen!');
+});
+```
+
+## Arguments
+- `seenTimestamp`: (Optional) Timestamp to mark as seen.
+- `callback(err)`: Callback called when the operation is done (error or null).

package/docs/muteThread.md

@@ -0,0 +1,16 @@
+# muteThread
+
+Mute or unmute a thread for a period of time.
+
+## Usage
+```js
+api.muteThread('1234567890', 60, (err) => {
+  if (err) return console.error(err);
+  console.log('Thread muted!');
+});
+```
+
+## Arguments
+- `threadID`: Thread ID (string).
+- `muteSeconds`: Number of seconds to mute (0 to unmute, -1 for indefinite).
+- `callback(err)`: Callback called when the operation is done (error or null).

package/docs/pinMessage.md

@@ -0,0 +1,17 @@
+# pinMessage
+
+Pin or unpin a message in a thread.
+
+## Usage
+```js
+api.pinMessage(true, 'mid.$cAA...', '1234567890', (err) => {
+  if (err) return console.error(err);
+  console.log('Message pinned!');
+});
+```
+
+## Arguments
+- `pinMode`: Boolean to pin (true) or unpin (false).
+- `messageID`: Message ID (string).
+- `threadID`: Thread ID (string).
+- `callback(err)`: Callback called when the operation is done (error or null).

package/docs/postFormData.md

@@ -0,0 +1,16 @@
+# postFormData
+
+Perform a raw HTTP POST request with form data (utility/advanced).
+
+## Usage
+```js
+api.postFormData('https://example.com', { key: 'value' }, (err, res) => {
+  if (err) return console.error(err);
+  console.log('Response:', res);
+});
+```
+
+## Arguments
+- `url`: URL to post to (string).
+- `formData`: Form data to send (object).
+- `callback(err, res)`: Callback with error or response object.

package/docs/refreshFb_dtsg.md

@@ -0,0 +1,14 @@
+# refreshFb_dtsg
+
+Refresh the Facebook fb_dtsg token (advanced/utility).
+
+## Usage
+```js
+api.refreshFb_dtsg((err, token) => {
+  if (err) return console.error(err);
+  console.log('fb_dtsg refreshed:', token);
+});
+```
+
+## Arguments
+- `callback(err, token)`: Callback with error or new token string.