wasm

func (*AuthenticatedConnection) Close ¶

func (ac *AuthenticatedConnection) Close(js.Value, []js.Value) any

Close deletes this AuthenticatedConnection's partner.Manager and releases resources.

Returns:

• Throws an error if closing fails.

func (*AuthenticatedConnection) GetId ¶

func (ac *AuthenticatedConnection) GetId(js.Value, []js.Value) any

GetId returns the ID for this bindings.AuthenticatedConnection in the authenticatedConnectionTracker.

Returns:

• Tracker ID (int).

func (*AuthenticatedConnection) GetPartner ¶

func (ac *AuthenticatedConnection) GetPartner(js.Value, []js.Value) any

GetPartner returns the partner.Manager for this AuthenticatedConnection.

Returns:

• Marshalled bytes of the partner's id.ID (Uint8Array).

func (*AuthenticatedConnection) IsAuthenticated ¶

func (ac *AuthenticatedConnection) IsAuthenticated(js.Value, []js.Value) any

IsAuthenticated returns true.

Returns:

• True (boolean).

func (*AuthenticatedConnection) RegisterListener ¶

func (ac *AuthenticatedConnection) RegisterListener(
	_ js.Value, args []js.Value) any

RegisterListener is used for E2E reception and allows for reading data sent from the partner.Manager.

Parameters:

• args[0] - Message type from catalog.MessageType (int).
• args[1] - Javascript object that has functions that implement the bindings.Listener interface.

Returns:

• Throws an error is registering the listener fails.

func (*AuthenticatedConnection) SendE2E ¶

func (ac *AuthenticatedConnection) SendE2E(_ js.Value, args []js.Value) any

SendE2E is a wrapper for sending specifically to the AuthenticatedConnection's partner.Manager.

Parameters:

• args[0] - Message type from catalog.MessageType (int).
• args[1] - Message payload (Uint8Array).

Returns a promise:

• Resolves to the JSON of bindings.E2ESendReport, which can be passed into Cmix.WaitForRoundResult to see if the send succeeded (Uint8Array).
• Rejected with an error if sending fails.

func (*Backup) AddJson ¶

func (b *Backup) AddJson(_ js.Value, args []js.Value) any

AddJson stores the argument within the Backup structure.

Parameters:

• args[0] - JSON to store (string).

func (*Backup) IsBackupRunning ¶

func (b *Backup) IsBackupRunning(js.Value, []js.Value) any

IsBackupRunning returns true if the backup has been initialized and is running. Returns false if it has been stopped.

Returns:

• If the backup is running (boolean).

func (*Backup) StopBackup ¶

func (b *Backup) StopBackup(js.Value, []js.Value) any

StopBackup stops the backup processes and deletes the user's password from storage. To enable backups again, call InitializeBackup.

Returns:

• Throws an error if stopping the backup fails.

func (*ChFilePartTracker) GetNumParts ¶ added in v0.3.3

func (fpt *ChFilePartTracker) GetNumParts(js.Value, []js.Value) any

GetNumParts returns the total number of file parts in the transfer.

Returns:

• Number of parts (int).

func (*ChFilePartTracker) GetPartStatus ¶ added in v0.3.3

func (fpt *ChFilePartTracker) GetPartStatus(_ js.Value, args []js.Value) any

GetPartStatus returns the status of the file part with the given part number.

The possible values for the status are:

• 0 < Part does not exist
• 0 = unsent
• 1 = arrived (sender has sent a part, and it has arrived)
• 2 = received (receiver has received a part)

Parameters:

• args[0] - Index of part (int).

Returns:

• Part status (int).

func (*ChannelsFileTransfer) CloseSend ¶ added in v0.3.3

func (cft *ChannelsFileTransfer) CloseSend(_ js.Value, args []js.Value) any

CloseSend deletes a file from the internal storage once a transfer has completed or reached the retry limit. If neither of those condition are met, an error is returned.

This function should be called once a transfer completes or errors out (as reported by the progress callback).

Parameters:

• args[0] - Marshalled bytes of the file's fileTransfer.ID (Uint8Array).

Returns a promise:

• Resolves on success (void).
• Rejected with an error if the file has not failed or completed or if closing failed.

func (*ChannelsFileTransfer) Download ¶ added in v0.3.3

func (cft *ChannelsFileTransfer) Download(_ js.Value, args []js.Value) any

Download begins the download of the file described in the marshalled channelsFileTransfer.FileInfo. The progress of the download is reported on the bindings.FtReceivedProgressCallback.

Once the download completes, the file will be stored in the event model with the given file ID and with the status channels.ReceptionProcessingComplete.

The bindings.FtReceivedProgressCallback only indicates the progress of the file download, not the status of the file in the event model. You must rely on updates from the event model to know when it can be retrieved.

Parameters:

• args[0] - The JSON of channelsFileTransfer.FileInfo received on a channel (Uint8Array).
• args[1] - The progress callback, which is a callback that reports the progress of the file download. The callback is called once on initialization, on every progress update (or less if restricted by the period), or on fatal error. It must be a Javascript object that implements the bindings.FtReceivedProgressCallback interface.
• args[2] - Progress callback period. A progress callback will be limited from triggering only once per period, in milliseconds (int).

Returns:

• Marshalled bytes of fileTransfer.ID that uniquely identifies the file.

Returns a promise:

• Resolves to the marshalled bytes of fileTransfer.ID that uniquely identifies the file. (Uint8Array).
• Rejected with an error if downloading fails.

func (*ChannelsFileTransfer) GetExtensionBuilderID ¶ added in v0.3.3

func (cft *ChannelsFileTransfer) GetExtensionBuilderID(js.Value, []js.Value) any

GetExtensionBuilderID returns the ID of the extension builder in the tracker. Pass this ID into the channel manager creator to use file transfer manager in conjunction with channels.

Returns:

• Extension builder ID (int).

func (*ChannelsFileTransfer) MaxFileNameLen ¶ added in v0.3.3

func (cft *ChannelsFileTransfer) MaxFileNameLen(js.Value, []js.Value) any

MaxFileNameLen returns the max number of bytes allowed for a file name.

Returns:

• Max number of bytes (int).

func (*ChannelsFileTransfer) MaxFileSize ¶ added in v0.3.3

func (cft *ChannelsFileTransfer) MaxFileSize(js.Value, []js.Value) any

MaxFileSize returns the max number of bytes allowed for a file.

Returns:

• Max number of bytes (int).

func (*ChannelsFileTransfer) MaxFileTypeLen ¶ added in v0.3.3

func (cft *ChannelsFileTransfer) MaxFileTypeLen(js.Value, []js.Value) any

MaxFileTypeLen returns the max number of bytes allowed for a file type.

Returns:

• Max number of bytes (int).

func (*ChannelsFileTransfer) MaxPreviewSize ¶ added in v0.3.3

func (cft *ChannelsFileTransfer) MaxPreviewSize(js.Value, []js.Value) any

MaxPreviewSize returns the max number of bytes allowed for a file preview.

Returns:

• Max number of bytes (int).

func (*ChannelsFileTransfer) RegisterReceivedProgressCallback ¶ added in v0.3.3

func (cft *ChannelsFileTransfer) RegisterReceivedProgressCallback(
	_ js.Value, args []js.Value) any

RegisterReceivedProgressCallback allows for the registration of a callback to track the progress of an individual file download.

The callback will be called immediately when added to report the current progress of the transfer. It will then call every time a file part is received, the transfer completes, or a fatal error occurs. It is called at most once every period regardless of the number of progress updates.

In the event that the client is closed and resumed, this function must be used to re-register any callbacks previously registered.

Once the download completes, the file will be stored in the event model with the given file ID and with the status channelsFileTransfer.Complete.

The bindings.FtReceivedProgressCallback only indicates the progress of the file download, not the status of the file in the event model. You must rely on updates from the event model to know when it can be retrieved.

Parameters:

• args[0] - Marshalled bytes of the file's fileTransfer.ID (Uint8Array).
• args[1] - The progress callback, which is a callback that reports the progress of the file download. The callback is called once on initialization, on every progress update (or less if restricted by the period), or on fatal error. It must be a Javascript object that implements the bindings.FtReceivedProgressCallback interface.
• args[2] - Progress callback period. A progress callback will be limited from triggering only once per period, in milliseconds (int).

Returns a promise:

• Resolves on success (void).
• Rejected with an error if registering the callback fails.

func (*ChannelsFileTransfer) RegisterSentProgressCallback ¶ added in v0.3.3

func (cft *ChannelsFileTransfer) RegisterSentProgressCallback(
	_ js.Value, args []js.Value) any

RegisterSentProgressCallback allows for the registration of a callback to track the progress of an individual file upload. A bindings.FtSentProgressCallback is auto-registered on ChannelsFileTransfer.Send; this function should be called when resuming clients or registering extra callbacks.

The callback will be called immediately when added to report the current progress of the transfer. It will then call every time a file part arrives, the transfer completes, or a fatal error occurs. It is called at most once every period regardless of the number of progress updates.

In the event that the client is closed and resumed, this function must be used to re-register any callbacks previously registered with this function or ChannelsFileTransfer.Send.

The bindings.FtSentProgressCallback only indicates the progress of the file upload, not the status of the file in the event model. You must rely on updates from the event model to know when it can be retrieved.

Parameters:

• args[0] - Marshalled bytes of the file's fileTransfer.ID (Uint8Array).
• args[1] - The progress callback, which is a callback that reports the progress of the file upload. The callback is called once on initialization, on every progress update (or less if restricted by the period), or on fatal error. It must be a Javascript object that implements the bindings.FtSentProgressCallback interface.
• args[2] - Progress callback period. A progress callback will be limited from triggering only once per period, in milliseconds (int).

Returns a promise:

• Resolves on success (void).
• Rejected with an error if registering the callback fails.

func (*ChannelsFileTransfer) RetryUpload ¶ added in v0.3.3

func (cft *ChannelsFileTransfer) RetryUpload(_ js.Value, args []js.Value) any

RetryUpload retries uploading a failed file upload. Returns an error if the transfer has not failed.

This function should be called once a transfer errors out (as reported by the progress callback).

A new progress callback must be registered on retry. Any previously registered callbacks are defunct when the upload fails.

Parameters:

• args[0] - Marshalled bytes of the file's fileTransfer.ID (Uint8Array).
• args[1] - The progress callback, which is a callback that reports the progress of the file upload. The callback is called once on initialization, on every progress update (or less if restricted by the period), or on fatal error. It must be a Javascript object that implements the bindings.FtSentProgressCallback interface.
• args[2] - Progress callback period. A progress callback will be limited from triggering only once per period, in milliseconds (int).

Returns a promise:

• Resolves on success (void).
• Rejected with an error if registering retrying the upload fails.

func (*ChannelsFileTransfer) Send ¶ added in v0.3.3

func (cft *ChannelsFileTransfer) Send(_ js.Value, args []js.Value) any

Send sends the specified file info to the channel. Once a file is uploaded via ChannelsFileTransfer.Upload, its file info (found in the event model) can be sent to any channel.

Parameters:

• args[0] - Marshalled bytes of the channel's id.ID to send the file to (Uint8Array).
• args[1] - JSON of channelsFileTransfer.FileLink stored in the event model (Uint8Array).
• args[2] - Human-readable file name. Max length defined by ChannelsFileTransfer.MaxFileNameLen (string).
• args[3] - Shorthand that identifies the type of file. Max length defined by ChannelsFileTransfer.MaxFileTypeLen (string).
• args[4] - A preview of the file data (e.g. a thumbnail). Max size defined by ChannelsFileTransfer.MaxPreviewSize (Uint8Array).
• args[5] - The duration, in milliseconds, that the file is available in the channel (int). For the maximum amount of time, use ValidForever.
• args[6] - JSON of xxdk.CMIXParams (Uint8Array). If left empty, GetDefaultCMixParams will be used internally.
• args[7] - JSON of a slice of public keys of users that should receive mobile notifications for the message.

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*ChannelsFileTransfer) Upload ¶ added in v0.3.3

func (cft *ChannelsFileTransfer) Upload(_ js.Value, args []js.Value) any

Upload starts uploading the file to a new ID that can be sent to the specified channel when complete. To get progress information about the upload, a bindings.FtSentProgressCallback must be registered. All errors returned on the callback are fatal and the user must take action to either ChannelsFileTransfer.RetryUpload or ChannelsFileTransfer.CloseSend.

The file is added to the event model at the returned file ID with the status channelsFileTransfer.Uploading. Once the upload is complete, the file link is added to the event model with the status channelsFileTransfer.Complete.

The bindings.FtSentProgressCallback only indicates the progress of the file upload, not the status of the file in the event model. You must rely on updates from the event model to know when it can be retrieved.

Parameters:

• args[0] - File contents. Max size defined by ChannelsFileTransfer.MaxFileSize (Uint8Array).
• args[1] - The number of sending retries allowed on send failure (e.g. a retry of 2.0 with 6 parts means 12 total possible sends) (float).
• args[2] - The progress callback, which is a callback that reports the progress of the file upload. The callback is called once on initialization, on every progress update (or less if restricted by the period), or on fatal error. It must be a Javascript object that implements the bindings.FtSentProgressCallback interface.
• args[3] - Progress callback period. A progress callback will be limited from triggering only once per period, in milliseconds (int).

Returns a promise:

• Resolves to the marshalled bytes of fileTransfer.ID that uniquely identifies the file (Uint8Array).
• Rejected with an error if initiating the upload fails.

func (*ChannelsManager) AreDMsEnabled ¶ added in v0.3.0

func (cm *ChannelsManager) AreDMsEnabled(_ js.Value, args []js.Value) any

AreDMsEnabled returns the status of direct messaging for a given channel.

Parameters:

• args[0] - Marshalled bytes of the channel id.ID (Uint8Array).

Returns:

• enabled (bool) - status of dms for passed in channel ID, true if enabled
• Throws an error if unmarshalling the channel ID

func (*ChannelsManager) DeleteChannelAdminKey ¶ added in v0.3.0

func (cm *ChannelsManager) DeleteChannelAdminKey(_ js.Value, args []js.Value) any

DeleteChannelAdminKey deletes the private key for the given channel.

CAUTION: This will remove admin access. This cannot be undone. If the private key is deleted, it cannot be recovered and the channel can never have another admin.

Parameters:

• args[0] - The marshalled bytes of the channel's id.ID (Uint8Array)

Returns:

• Throws an error if the deletion fails.

func (*ChannelsManager) DeleteMessage ¶ added in v0.3.0

func (cm *ChannelsManager) DeleteMessage(_ js.Value, args []js.Value) any

DeleteMessage deletes the targeted message from user's view. Users may delete their own messages but only the channel admin can delete other user's messages. If the user is not an admin of the channel or if they are not the sender of the targetMessage, then the error channels.NotAnAdminErr is returned.

If undoAction is true, then the targeted message is un-deleted.

Clients will drop the deletion if they do not recognize the target message.

Parameters:

• args[0] - Marshalled bytes of channel id.ID (Uint8Array).
• args[1] - The marshalled [channel.MessageID] of the message you want to delete (Uint8Array).
• args[2] - JSON of xxdk.CMIXParams. This may be empty, and GetDefaultCMixParams will be used internally (Uint8Array).

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*ChannelsManager) DeleteNickname ¶

func (cm *ChannelsManager) DeleteNickname(_ js.Value, args []js.Value) any

DeleteNickname removes the nickname for a given channel. The name will revert back to the codename for this channel instead.

Parameters:

• args[0] - Marshalled bytes if the channel's id.ID (Uint8Array).

Returns:

• Throws TypeError if deleting the nickname fails.

func (*ChannelsManager) DisableDirectMessages ¶ added in v0.3.0

func (cm *ChannelsManager) DisableDirectMessages(_ js.Value, args []js.Value) any

DisableDirectMessages removes the token for direct messaging for a given channel.

Parameters:

• args[0] - Marshalled bytes of the channel id.ID (Uint8Array).

Returns:

• Throws an error if saving the DM token fails

func (*ChannelsManager) EnableDirectMessages ¶ added in v0.3.0

func (cm *ChannelsManager) EnableDirectMessages(_ js.Value, args []js.Value) any

EnableDirectMessages enables the token for direct messaging for this channel.

Parameters:

• args[0] - Marshalled bytes of the channel id.ID (Uint8Array).

Returns:

• Throws an error if saving the DM token fails.

func (*ChannelsManager) ExportChannelAdminKey ¶ added in v0.3.0

func (cm *ChannelsManager) ExportChannelAdminKey(_ js.Value, args []js.Value) any

ExportChannelAdminKey gets the private key for the given channel ID, encrypts it with the provided encryptionPassword, and exports it into a portable format. Returns an error if the user is not an admin of the channel.

This key can be provided to other users in a channel to grant them admin access using ChannelsManager.ImportChannelAdminKey.

The private key is encrypted using a key generated from the password using Argon2. Each call to ExportChannelAdminKey produces a different encrypted packet regardless if the same password is used for the same channel. It cannot be determined which channel the payload is for nor that two payloads are for the same channel.

The passwords between each call are not related. They can be the same or different with no adverse impact on the security properties.

Parameters:

• args[0] - Marshalled bytes of the channel's id.ID (Uint8Array).
• args[1] - The password used to encrypt the private key (string). The passwords between each call are not related. They can be the same or different with no adverse impact on the security properties.

Returns:

• Portable string of the channel private key encrypted with the password (Uint8Array).
• Throws an error if the user is not an admin for the channel.

func (*ChannelsManager) ExportPrivateIdentity ¶

func (cm *ChannelsManager) ExportPrivateIdentity(_ js.Value, args []js.Value) any

ExportPrivateIdentity encrypts the private identity using the password and exports it to a portable string.

Parameters:

• password - The password used to encrypt the private identity (string).

Returns:

• Encrypted portable private identity (Uint8Array).
• Throws TypeError if exporting the identity fails.

func (*ChannelsManager) GenerateChannel ¶ added in v0.3.0

func (cm *ChannelsManager) GenerateChannel(_ js.Value, args []js.Value) any

GenerateChannel creates a new channel with the user as the admin and returns the pretty print of the channel. This function only create a channel and does not join it.

The private key is saved to storage and can be accessed with ChannelsManager.ExportChannelAdminKey.

Parameters:

• args[0] - The name of the new channel (string). The name must be between 3 and 24 characters inclusive. It can only include upper and lowercase Unicode letters, digits 0 through 9, and underscores (_). It cannot be changed once a channel is created.
• args[1] - The description of a channel (string). The description is optional but cannot be longer than 144 characters and can include all Unicode characters. It cannot be changed once a channel is created.
• args[2] - The broadcast.PrivacyLevel of the channel (int). 0 = public, 1 = private, and 2 = secret. Refer to the comment below for more information.

Returns a promise:

• Resolves to the pretty print of the channel (string).
• Rejected with an error if generating the channel fails.

The broadcast.PrivacyLevel of a channel indicates the level of channel information revealed when sharing it via URL. For any channel besides public channels, the secret information is encrypted and a password is required to share and join a channel.

• A privacy level of broadcast.Public reveals all the information including the name, description, privacy level, public key and salt.
• A privacy level of broadcast.Private reveals only the name and description.
• A privacy level of broadcast.Secret reveals nothing.

func (*ChannelsManager) GetChannels ¶

func (cm *ChannelsManager) GetChannels(js.Value, []js.Value) any

GetChannels returns the IDs of all channels that have been joined.

Returns:

• JSON of an array of marshalled id.ID (Uint8Array).
• Throws an error if getting the channels fails.

JSON Example:

{
  "U4x/lrFkvxuXu59LtHLon1sUhPJSCcnZND6SugndnVID",
  "15tNdkKbYXoMn58NO6VbDMDWFEyIhTWEGsvgcJsHWAgD"
}

func (*ChannelsManager) GetID ¶

func (cm *ChannelsManager) GetID(js.Value, []js.Value) any

GetID returns the ID for this ChannelsManager in the ChannelsManager tracker.

Returns:

• Tracker ID (int).

func (*ChannelsManager) GetIdentity ¶

func (cm *ChannelsManager) GetIdentity(js.Value, []js.Value) any

GetIdentity returns the public identity ([channel.Identity]) of the user associated with this channel manager.

Returns:

• JSON of the [channel.Identity] (Uint8Array).
• Throws TypeError if marshalling the identity fails.

func (*ChannelsManager) GetMutedUsers ¶ added in v0.3.0

func (cm *ChannelsManager) GetMutedUsers(_ js.Value, args []js.Value) any

GetMutedUsers returns the list of the public keys for each muted user in the channel. If there are no muted user or if the channel does not exist, an empty list is returned.

Parameters:

• args[0] - Marshalled bytes if the channel's id.ID (Uint8Array).

Returns:

• JSON of an array of ed25519.PublicKey (Uint8Array). Look below for an example.
• Throws an error if the channel ID cannot be unmarshalled.

Example return:

["k2IrybDXjJtqxjS6Tx/6m3bXvT/4zFYOJnACNWTvESE=","ocELv7KyeCskLz4cm0klLWhmFLYvQL2FMDco79GTXYw=","mmxoDgoTEYwaRyEzq5Npa24IIs+3B5LXhll/8K5yCv0="]

func (*ChannelsManager) GetNickname ¶

func (cm *ChannelsManager) GetNickname(_ js.Value, args []js.Value) any

GetNickname returns the nickname set for a given channel. Returns an error if there is no nickname set.

Parameters:

• args[0] - Marshalled bytes if the channel's id.ID (Uint8Array).

Returns:

• The nickname set for the channel (string).
• Throws TypeError if the channel has no nickname set.

func (*ChannelsManager) GetNotificationLevel ¶ added in v0.3.4

func (cm *ChannelsManager) GetNotificationLevel(_ js.Value, args []js.Value) any

GetNotificationLevel returns the channels.NotificationLevel for the given channel.

Parameters:

• args[0] - The marshalled bytes of the channel's id.ID (Uint8Array).

Returns:

• The channels.NotificationLevel for the channel (int).
• Throws an error if the channel ID cannot be unmarshalled or the channel cannot be found.

func (*ChannelsManager) GetNotificationStatus ¶ added in v0.3.4

func (cm *ChannelsManager) GetNotificationStatus(_ js.Value, args []js.Value) any

GetNotificationStatus returns the notification status for the given channel.

Parameters:

• args[0] - The marshalled bytes of the channel's id.ID (Uint8Array).

Returns:

• The [notifications.NotificationState] for the channel (int).
• Throws an error if the channel ID cannot be unmarshalled or the channel cannot be found.

func (*ChannelsManager) GetShareURL ¶

func (cm *ChannelsManager) GetShareURL(_ js.Value, args []js.Value) any

GetShareURL generates a URL that can be used to share this channel with others on the given host.

A URL comes in one of three forms based on the privacy level set when generating the channel. Each privacy level hides more information than the last with the lowest level revealing everything and the highest level revealing nothing. For any level above the lowest, a password is returned, which will be required when decoding the URL.

The maxUses is the maximum number of times this URL can be used to join a channel. If it is set to 0, then it can be shared unlimited times. The max uses is set as a URL parameter using the key broadcast.MaxUsesKey. Note that this number is also encoded in the secret data for private and secret URLs, so if the number is changed in the URL, it will be verified when calling DecodePublicURL and DecodePrivateURL. There is no enforcement for public URLs.

Parameters:

• args[0] - ID of Cmix object in tracker (int).
• args[1] - The URL to append the channel info to (string).
• args[2] - The maximum number of uses the link can be used (0 for unlimited) (int).
• args[3] - Marshalled bytes of the channel id.ID (Uint8Array).

Returns:

• JSON of bindings.ShareURL (Uint8Array).
• Throws an error if generating the URL fails.

func (*ChannelsManager) GetStorageTag ¶

func (cm *ChannelsManager) GetStorageTag(js.Value, []js.Value) any

GetStorageTag returns the tag where this manager is stored. To be used when loading the manager. The storage tag is derived from the public key.

Returns:

• Storage tag (string).

func (*ChannelsManager) ImportChannelAdminKey ¶ added in v0.3.0

func (cm *ChannelsManager) ImportChannelAdminKey(_ js.Value, args []js.Value) any

ImportChannelAdminKey decrypts and imports the given encrypted private key and grants the user admin access to the channel the private key belongs to. Returns an error if the private key cannot be decrypted or if the private key is for the wrong channel.

Parameters:

• args[0] - Marshalled bytes of the channel's id.ID (Uint8Array).
• args[1] - The password used to encrypt the private key (string)
• args[2] - The encrypted channel private key packet (Uint8Array).

Returns:

• Throws an error if the password is invalid or the private key does not match the channel ID.
• Throws an error with the message channels.WrongPasswordErr for an invalid password.
• Throws an error with the message channels.ChannelDoesNotExistsErr if the channel has not already been joined.
• Throws an error with the message channels.WrongPrivateKeyErr if the private key does not belong to the channel.

func (*ChannelsManager) IsChannelAdmin ¶ added in v0.3.0

func (cm *ChannelsManager) IsChannelAdmin(_ js.Value, args []js.Value) any

IsChannelAdmin returns true if the user is an admin of the channel.

Parameters:

• args[0] - The marshalled bytes of the channel's id.ID (Uint8Array)

Returns:

• True if the user is an admin in the channel and false otherwise (boolean).
• Throws an error if the channel ID cannot be unmarshalled.

func (*ChannelsManager) JoinChannel ¶

func (cm *ChannelsManager) JoinChannel(_ js.Value, args []js.Value) any

JoinChannel joins the given channel. It will return the error channels.ChannelAlreadyExistsErr if the channel has already been joined.

Parameters:

• args[0] - A portable channel string. Should be received from another user or generated via ChannelsManager.GenerateChannel (string).

The pretty print will be of the format:

<Speakeasy-v3:Test_Channel|description:Channel description.|level:Public|created:1666718081766741100|secrets:+oHcqDbJPZaT3xD5NcdLY8OjOMtSQNKdKgLPmr7ugdU=|rCI0wr01dHFStjSFMvsBzFZClvDIrHLL5xbCOPaUOJ0=|493|1|7cBhJxVfQxWo+DypOISRpeWdQBhuQpAZtUbQHjBm8NQ=>

Returns a promise:

• Resolves to the JSON of bindings.ChannelInfo, which describes all relevant channel information (Uint8Array).
• Rejected with an error if joining the channel fails.

func (*ChannelsManager) LeaveChannel ¶

func (cm *ChannelsManager) LeaveChannel(_ js.Value, args []js.Value) any

LeaveChannel leaves the given channel. It will return the error channels.ChannelDoesNotExistsErr if the channel was not previously joined.

Parameters:

• args[0] - Marshalled bytes of the channel id.ID (Uint8Array).

Returns a promise:

• Resolves on success (void).
• Rejected with an error if the channel does not exist.

func (*ChannelsManager) MuteUser ¶ added in v0.3.0

func (cm *ChannelsManager) MuteUser(_ js.Value, args []js.Value) any

MuteUser is used to mute a user in a channel. Muting a user will cause all future messages from the user being dropped on reception. Muted users are also unable to send messages. Only the channel admin can mute a user; if the user is not an admin of the channel, then the error channels.NotAnAdminErr is returned.

If undoAction is true, then the targeted user will be unmuted.

Parameters:

• args[0] - Marshalled bytes of channel id.ID (Uint8Array).
• args[1] - The ed25519.PublicKey of the user you want to mute (Uint8Array).
• args[2] - Set to true to unmute the message (boolean).
• args[3] - The time, in milliseconds, that the user should be muted (int). To remain muted indefinitely, use ValidForever.
• args[4] - JSON of xxdk.CMIXParams. This may be empty, and GetDefaultCMixParams will be used internally (Uint8Array).

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*ChannelsManager) Muted ¶ added in v0.3.0

func (cm *ChannelsManager) Muted(_ js.Value, args []js.Value) any

Muted returns true if the user is currently muted in the given channel.

Parameters:

• args[0] - Marshalled bytes if the channel's id.ID (Uint8Array).

Returns:

• Returns true if the user is muted in the channel and false otherwise (boolean).
• Throws an error if the channel ID cannot be unmarshalled.

func (*ChannelsManager) PinMessage ¶ added in v0.3.0

func (cm *ChannelsManager) PinMessage(_ js.Value, args []js.Value) any

PinMessage pins the target message to the top of a channel view for all users in the specified channel. Only the channel admin can pin user messages; if the user is not an admin of the channel, then the error channels.NotAnAdminErr is returned.

If undoAction is true, then the targeted message is unpinned.

Clients will drop the pin if they do not recognize the target message.

Parameters:

• args[0] - Marshalled bytes of channel id.ID (Uint8Array).
• args[1] - The marshalled [channel.MessageID] of the message you want to pin (Uint8Array).
• args[2] - Set to true to unpin the message (boolean).
• args[3] - The time, in milliseconds, that the message should be pinned (int). To remain pinned indefinitely, use ValidForever.
• args[4] - JSON of xxdk.CMIXParams. This may be empty, and GetDefaultCMixParams will be used internally (Uint8Array).

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*ChannelsManager) RegisterReceiveHandler ¶

func (cm *ChannelsManager) RegisterReceiveHandler(_ js.Value, args []js.Value) any

RegisterReceiveHandler is used to register handlers for non-default message types. They can be processed by modules. It is important that such modules sync up with the event model implementation.

There can only be one handler per channels.MessageType, and this will return an error on any re-registration.

Parameters:

• args[0] - The message type of the message. This will be a valid channels.MessageType (int).
• args[1] - Javascript object that has functions that implement the bindings.ChannelMessageReceptionCallback interface. This callback will be executed when a channel message of the messageType is received.
• args[2] - A name describing what type of messages the listener picks up. This is used for debugging and logging (string).
• args[3] - Set to true if this listener can receive messages from normal users (boolean).
• args[4] - Set to true if this listener can receive messages from admins (boolean).
• args[5] - Set to true if this listener can receive messages from muted users (boolean).

Returns:

• Throws an error if registering the handler fails.

func (*ChannelsManager) ReplayChannel ¶

func (cm *ChannelsManager) ReplayChannel(_ js.Value, args []js.Value) any

ReplayChannel replays all messages from the channel within the network's memory (~3 weeks) over the event model.

Returns the error channels.ChannelDoesNotExistsErr if the channel was not previously joined.

Parameters:

• args[0] - Marshalled bytes of the channel's id.ID (Uint8Array).

Returns:

• Throws an error if the replay fails.

func (*ChannelsManager) SendAdminGeneric ¶

func (cm *ChannelsManager) SendAdminGeneric(_ js.Value, args []js.Value) any

SendAdminGeneric is used to send a raw message over a channel encrypted with admin keys, identifying it as sent by the admin. In general, it should be wrapped in a function that defines the wire protocol.

If the final message, before being sent over the wire, is too long, this will return an error. The message must be at most 510 bytes long.

If the user is not an admin of the channel (i.e. does not have a private key for the channel saved to storage), then the error channels.NotAnAdminErr is returned.

Parameters:

• args[0] - Marshalled bytes of the channel id.ID (Uint8Array).
• args[1] - The message type of the message. This will be a valid channels.MessageType (int).
• args[2] - The contents of the message (Uint8Array). The message should be at most 510 bytes.
• args[3] - The lease of the message. This will be how long the message is available from the network, in milliseconds (int). As per the channels.Manager documentation, this has different meanings depending on the use case. These use cases may be generic enough that they will not be enumerated here. Use ValidForever to last the max message life.
• args[4] - Set tracked to true if the message should be tracked in the sendTracker, which allows messages to be shown locally before they are received on the network. In general, all messages that will be displayed to the user should be tracked while all actions should not be (boolean).
• args[5] - JSON of xxdk.CMIXParams. If left empty bindings.GetDefaultCMixParams will be used internally (Uint8Array).

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*ChannelsManager) SendGeneric ¶

func (cm *ChannelsManager) SendGeneric(_ js.Value, args []js.Value) any

SendGeneric is used to send a raw message over a channel. In general, it should be wrapped in a function that defines the wire protocol.

If the final message, before being sent over the wire, is too long, this will return an error. Due to the underlying encoding using compression, it is not possible to define the largest payload that can be sent, but it will always be possible to send a payload of 802 bytes at minimum.

Parameters:

• args[0] - Marshalled bytes of the channel id.ID (Uint8Array).
• args[1] - The message type of the message. This will be a valid channels.MessageType (int).
• args[2] - The contents of the message (Uint8Array).
• args[3] - The lease of the message. This will be how long the message is available from the network, in milliseconds (int). As per the channels.Manager documentation, this has different meanings depending on the use case. These use cases may be generic enough that they will not be enumerated here. Use ValidForever to last the max message life.
• args[4] - Set tracked to true if the message should be tracked in the sendTracker, which allows messages to be shown locally before they are received on the network. In general, all messages that will be displayed to the user should be tracked while all actions should not be (boolean).
• args[5] - JSON of xxdk.CMIXParams. If left empty bindings.GetDefaultCMixParams will be used internally (Uint8Array).
• args[6] - JSON of a map of slices of ed25519.PublicKey of users that should receive mobile notifications for the message. Each slice keys on a channels.PingType that describes the type of notification it is (Uint8Array).

Example map of slices of public keys:

{
  "usrMention": [
    "CLdKxbe8D2WVOpx1mT63TZ5CP/nesmxHLT5DUUalpe0=",
    "S2c6NXjNqgR11SCOaiQUughWaLpWBKNufPt6cbTVHMA="
  ],
  "usrReply": [
    "aaMzSeA6Cu2Aix2MlOwzrAI+NnpKshzvZRT02PZPVec="
  ]
}

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*ChannelsManager) SendInvite ¶ added in v0.3.4

func (cm *ChannelsManager) SendInvite(_ js.Value, args []js.Value) any

SendInvite is used to send to a channel (invited) an invitation to another channel (invitee).

If the channel ID for the invitee channel is not recognized by the Manager, then an error will be returned.

Parameters:

• args[0] - Marshalled bytes of the invited channel id.ID (Uint8Array).
• args[1] - JSON of the invitee channel id.ID. This can be retrieved from GetChannelJSON. (Uint8Array).
• args[2] - The contents of the message (string).
• args[3] - The URL to append the channel info to (string).
• args[4] - The lease of the message. This will be how long the message is available from the network, in milliseconds (int). As per the channels.Manager documentation, this has different meanings depending on the use case. These use cases may be generic enough that they will not be enumerated here. Use ValidForever to last the max message life.
• args[5] - JSON of xxdk.CMIXParams. If left empty bindings.GetDefaultCMixParams will be used internally (Uint8Array).
• args[6] - JSON of a slice of public keys of users that should receive mobile notifications for the message.

Example slice of public keys:

[
  "FgJMvgSsY4rrKkS/jSe+vFOJOs5qSSyOUSW7UtF9/KU=",
  "fPqcHtrJ398PAC35QyWXEU9PHzz8Z4BKQTCxSvpSygw=",
  "JnjCgh7g/+hNiI9VPKW01aRSxGOFmNulNCymy3ImXAo="
]

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*ChannelsManager) SendMessage ¶

func (cm *ChannelsManager) SendMessage(_ js.Value, args []js.Value) any

SendMessage is used to send a formatted message over a channel.

Due to the underlying encoding using compression, it isn't possible to define the largest payload that can be sent, but it will always be possible to send a payload of 798 bytes at minimum.

The message will auto delete validUntil after the round it is sent in, lasting forever if channels.ValidForever is used.

Parameters:

• args[0] - Marshalled bytes of the channel id.ID (Uint8Array).
• args[1] - The contents of the message (string).
• args[2] - The lease of the message. This will be how long the message is available from the network, in milliseconds (int). As per the channels.Manager documentation, this has different meanings depending on the use case. These use cases may be generic enough that they will not be enumerated here. Use ValidForever to last the max message life.
• args[3] - JSON of xxdk.CMIXParams. If left empty bindings.GetDefaultCMixParams will be used internally (Uint8Array).
• args[4] - JSON of a slice of public keys of users that should receive mobile notifications for the message.

Example slice of public keys:

[
  "FgJMvgSsY4rrKkS/jSe+vFOJOs5qSSyOUSW7UtF9/KU=",
  "fPqcHtrJ398PAC35QyWXEU9PHzz8Z4BKQTCxSvpSygw=",
  "JnjCgh7g/+hNiI9VPKW01aRSxGOFmNulNCymy3ImXAo="
]

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*ChannelsManager) SendReaction ¶

func (cm *ChannelsManager) SendReaction(_ js.Value, args []js.Value) any

SendReaction is used to send a reaction to a message over a channel. The reaction must be a single emoji with no other characters, and will be rejected otherwise.

Clients will drop the reaction if they do not recognize the reactTo message.

Parameters:

• args[0] - Marshalled bytes of the channel id.ID (Uint8Array).
• args[1] - The user's reaction. This should be a single emoji with no other characters. As such, a Unicode string is expected (string).
• args[2] - JSON of [channel.MessageID] of the message you wish to reply to. This may be found in the bindings.ChannelSendReport if replying to your own. Alternatively, if reacting to another user's message, you may retrieve it via the ChannelMessageReceptionCallback registered using RegisterReceiveHandler (Uint8Array).
• args[3] - The lease of the message. This will be how long the message is available from the network, in milliseconds (int). As per the channels.Manager documentation, this has different meanings depending on the use case. These use cases may be generic enough that they will not be enumerated here. Use ValidForever to last the max message life.
• args[4] - JSON of xxdk.CMIXParams. If left empty bindings.GetDefaultCMixParams will be used internally (Uint8Array).

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*ChannelsManager) SendReply ¶

func (cm *ChannelsManager) SendReply(_ js.Value, args []js.Value) any

SendReply is used to send a formatted message over a channel.

Due to the underlying encoding using compression, it is not possible to define the largest payload that can be sent, but it will always be possible to send a payload of 766 bytes at minimum.

If the message ID that the reply is sent to does not exist, then the other side will post the message as a normal message and not as a reply.

Parameters:

• args[0] - Marshalled bytes of the channel id.ID (Uint8Array).
• args[1] - The contents of the message. The message should be at most 510 bytes. This is expected to be Unicode, and thus a string data type is expected (string).
• args[2] - JSON of [channel.MessageID] of the message you wish to reply to. This may be found in the bindings.ChannelSendReport if replying to your own. Alternatively, if reacting to another user's message, you may retrieve it via the bindings.ChannelMessageReceptionCallback registered using RegisterReceiveHandler (Uint8Array).
• args[3] - The lease of the message. This will be how long the message is available from the network, in milliseconds (int). As per the channels.Manager documentation, this has different meanings depending on the use case. These use cases may be generic enough that they will not be enumerated here. Use ValidForever to last the max message life.
• args[4] - JSON of xxdk.CMIXParams. If left empty bindings.GetDefaultCMixParams will be used internally (Uint8Array).
• args[5] - JSON of a slice of public keys of users that should receive mobile notifications for the message.

Example slice of public keys:

[
  "FgJMvgSsY4rrKkS/jSe+vFOJOs5qSSyOUSW7UtF9/KU=",
  "fPqcHtrJ398PAC35QyWXEU9PHzz8Z4BKQTCxSvpSygw=",
  "JnjCgh7g/+hNiI9VPKW01aRSxGOFmNulNCymy3ImXAo="
]

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*ChannelsManager) SendSilent ¶ added in v0.3.4

func (cm *ChannelsManager) SendSilent(_ js.Value, args []js.Value) any

SendSilent is used to send to a channel a message with no notifications. Its primary purpose is to communicate new nicknames without calling [SendMessage].

It takes no payload intentionally as the message should be very lightweight.

Parameters:

• args[0] - Marshalled bytes of the channel id.ID (Uint8Array).
• args[1] - The lease of the message. This will be how long the message is available from the network, in milliseconds (int). As per the channels.Manager documentation, this has different meanings depending on the use case. These use cases may be generic enough that they will not be enumerated here. Use ValidForever to last the max message life.
• args[2] - JSON of xxdk.CMIXParams. If left empty bindings.GetDefaultCMixParams will be used internally (Uint8Array).

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*ChannelsManager) SetMobileNotificationsLevel ¶ added in v0.3.4

func (cm *ChannelsManager) SetMobileNotificationsLevel(_ js.Value,
	args []js.Value) any

SetMobileNotificationsLevel sets the notification level for the given channel. The channels.NotificationLevel dictates the type of notifications received and the status controls weather the notification is push or in-app. If muted, both the level and status must be set to mute.

To use push notifications, a token must be registered with the notification manager. Note, when enabling push notifications, information may be shared with third parties (i.e., Firebase and Google's Palantir) and may represent a security risk to the user.

Parameters:

• args[0] - The marshalled bytes of the channel's id.ID (Uint8Array).
• args[1] - The channels.NotificationLevel to set for the channel (int).
• args[2] - The [notifications.NotificationState] to set for the channel (int).

Returns a promise and throws an error if setting the notification level fails.

func (*ChannelsManager) SetNickname ¶

func (cm *ChannelsManager) SetNickname(_ js.Value, args []js.Value) any

SetNickname sets the nickname for a given channel. The nickname must be valid according to IsNicknameValid.

Parameters:

• args[0] - The nickname to set (string).
• args[1] - Marshalled bytes if the channel's id.ID (Uint8Array).

Returns:

• Throws TypeError if unmarshalling the ID fails or the nickname is invalid.

func (*ChannelsManager) VerifyChannelAdminKey ¶ added in v0.3.0

func (cm *ChannelsManager) VerifyChannelAdminKey(_ js.Value, args []js.Value) any

VerifyChannelAdminKey verifies that the encrypted private key can be decrypted and that it matches the expected channel. Returns false if private key does not belong to the given channel.

Parameters:

• args[0] - Marshalled bytes of the channel's id.ID (Uint8Array).
• args[1] - The password used to encrypt the private key (string)
• args[2] - The encrypted channel private key packet (Uint8Array).

Returns:

• Returns false if private key does not belong to the given channel ID (boolean).
• Throws an error if the password is invalid.

Returns:

• bool - True if the private key belongs to the channel and false otherwise.
• Throws an error with the message channels.WrongPasswordErr for an invalid password.
• Throws an error with the message channels.ChannelDoesNotExistsErr i the channel has not already been joined.

func (*Cmix) AddHealthCallback ¶

func (c *Cmix) AddHealthCallback(_ js.Value, args []js.Value) any

AddHealthCallback adds a callback that gets called whenever the network health changes. Returns a registration ID that can be used to unregister.

Parameters:

• args[0] - Javascript object that has functions that implement the bindings.NetworkHealthCallback interface.

Returns:

• A registration ID that can be used to unregister the callback (int).

func (*Cmix) ChangeNumberOfNodeRegistrations ¶

func (c *Cmix) ChangeNumberOfNodeRegistrations(_ js.Value, args []js.Value) any

ChangeNumberOfNodeRegistrations changes the number of parallel node registrations up to the initialized maximum.

Parameters:

• args[0] - The number of parallel node registrations (int).
• args[1] - The timeout, in milliseconds, to wait when changing node registrations before failing (int).

Returns:

• Throws TypeError if changing registrations fails.

func (*Cmix) Connect ¶

func (c *Cmix) Connect(_ js.Value, args []js.Value) any

Connect performs auth key negotiation with the given recipient and returns a Connection object for the newly created partner.Manager.

This function is to be used sender-side and will block until the partner.Manager is confirmed.

Parameters:

• args[0] - ID of E2e object in tracker (int).
• args[1] - Marshalled bytes of the recipient contact.Contact (Uint8Array).
• args[3] - JSON of xxdk.E2EParams (Uint8Array).

Returns a promise:

• Resolves to a Javascript representation of the Connection object.
• Rejected with an error if loading the parameters or connecting fails.

func (*Cmix) ConnectWithAuthentication ¶

func (c *Cmix) ConnectWithAuthentication(_ js.Value, args []js.Value) any

ConnectWithAuthentication is called by the client (i.e., the one establishing connection with the server). Once a connect.Connection has been established with the server, it then authenticates their identity to the server.

Parameters:

• args[0] - ID of E2e object in tracker (int).
• args[1] - Marshalled bytes of the recipient contact.Contact (Uint8Array).
• args[3] - JSON of xxdk.E2EParams (Uint8Array).

Returns a promise:

• Resolves to a Javascript representation of the Connection object.
• Rejected with an error if loading the parameters or connecting fails.

func (*Cmix) EKVGet ¶ added in v0.3.4

func (c *Cmix) EKVGet(_ js.Value, args []js.Value) any

EKVGet allows access to a value inside the secure encrypted key value store.

Parameters:

• args[0] - Key (string).

Returns a promise:

• Resolves to the value (Uint8Array)
• Rejected with an error if accessing the KV fails.

func (*Cmix) EKVSet ¶ added in v0.3.4

func (c *Cmix) EKVSet(_ js.Value, args []js.Value) any

EKVSet sets a value inside the secure encrypted key value store.

Parameters:

• args[0] - Key (string).
• args[1] - Value (Uint8Array).

Returns a promise:

• Resolves on a successful save (void).
• Rejected with an error if saving fails.

func (*Cmix) GetID ¶

func (c *Cmix) GetID(js.Value, []js.Value) any

GetID returns the ID for this bindings.Cmix in the cmixTracker.

Returns:

• Tracker ID (int).

func (*Cmix) GetNodeRegistrationStatus ¶

func (c *Cmix) GetNodeRegistrationStatus(js.Value, []js.Value) any

GetNodeRegistrationStatus returns the current state of node registration.

Returns:

• JSON of bindings.NodeRegistrationReport containing the number of nodes that the user is registered with and the number of nodes present in the NDF.
• An error if it cannot get the node registration status. The most likely cause is that the network is unhealthy.

func (*Cmix) GetReceptionID ¶ added in v0.3.4

func (c *Cmix) GetReceptionID(js.Value, []js.Value) any

GetReceptionID returns the default reception identity for this cMix instance.

Returns:

• Marshalled bytes of id.ID (Uint8Array).

func (*Cmix) GetReceptionRegistrationValidationSignature ¶

func (c *Cmix) GetReceptionRegistrationValidationSignature(
	js.Value, []js.Value) any

GetReceptionRegistrationValidationSignature returns the signature provided by the xx network.

Returns:

• Reception registration validation signature (Uint8Array).

func (*Cmix) GetRemoteKV ¶ added in v0.3.4

func (c *Cmix) GetRemoteKV(js.Value, []js.Value) any

GetRemoteKV returns the cMix RemoteKV

Returns a promise:

• Resolves with the RemoteKV object.

func (*Cmix) GetRunningProcesses ¶

func (c *Cmix) GetRunningProcesses(js.Value, []js.Value) any

GetRunningProcesses returns the names of all running processes at the time of this call. Note that this list may change and is subject to race conditions if multiple threads are in the process of starting or stopping.

Returns:

• JSON of strings (Uint8Array).
• Throws TypeError if getting the processes fails.

JSON Example:

{
  "FileTransfer{BatchBuilderThread, FilePartSendingThread#0, FilePartSendingThread#1, FilePartSendingThread#2, FilePartSendingThread#3}",
  "MessageReception Worker 0"
}

func (*Cmix) HasRunningProcessies ¶

func (c *Cmix) HasRunningProcessies(js.Value, []js.Value) any

HasRunningProcessies checks if any background threads are running and returns true if one or more are.

This is meant to be used when Cmix.NetworkFollowerStatus returns Stopping. Due to the handling of comms on iOS, where the OS can block indefinitely, it may not enter the stopped state appropriately. This can be used instead.

Returns:

• True if there are running processes (boolean).

func (*Cmix) IsHealthy ¶

func (c *Cmix) IsHealthy(js.Value, []js.Value) any

IsHealthy returns true if the network is read to be in a healthy state where messages can be sent.

Returns:

• True if the network is healthy (boolean).

func (*Cmix) IsReady ¶

func (c *Cmix) IsReady(_ js.Value, args []js.Value) any

IsReady returns true if at least the given percent of node registrations have completed. If not all have completed, then it returns false and howClose will be a percent (0-1) of node registrations completed.

Parameters:

• args[0] - The percentage of nodes required to be registered with to be ready. This is a number between 0 and 1 (float64).

Returns:

• JSON of bindings.IsReadyInfo (Uint8Array).
• Throws TypeError if getting the information fails.

func (*Cmix) MakeLegacyReceptionIdentity ¶

func (c *Cmix) MakeLegacyReceptionIdentity(js.Value, []js.Value) any

MakeLegacyReceptionIdentity generates the legacy identity for receiving messages.

Returns a promise:

• Resolves to the JSON of the xxdk.ReceptionIdentity object (Uint8Array).
• Rejected with an error if creating a new legacy identity fails.

func (*Cmix) MakeReceptionIdentity ¶

func (c *Cmix) MakeReceptionIdentity(js.Value, []js.Value) any

MakeReceptionIdentity generates a new cryptographic identity for receiving messages.

Returns a promise:

• Resolves to the JSON of the xxdk.ReceptionIdentity object (Uint8Array).
• Rejected with an error if creating a new identity fails.

func (*Cmix) NetworkFollowerStatus ¶

func (c *Cmix) NetworkFollowerStatus(js.Value, []js.Value) any

NetworkFollowerStatus gets the state of the network follower. It returns a status with the following values:

Stopped  - 0
Running  - 2000
Stopping - 3000

Returns:

• Network status code (int).

func (*Cmix) PauseNodeRegistrations ¶

func (c *Cmix) PauseNodeRegistrations(_ js.Value, args []js.Value) any

PauseNodeRegistrations stops all node registrations and returns a function to resume them.

Parameters:

• args[0] - The timeout, in milliseconds, to wait when stopping threads before failing (int).

Returns:

• Throws TypeError if pausing fails.

func (*Cmix) ReadyToSend ¶

func (c *Cmix) ReadyToSend(js.Value, []js.Value) any

ReadyToSend determines if the network is ready to send messages on. It returns true if the network is healthy and if the client has registered with at least 70% of the nodes. Returns false otherwise.

Returns:

• Returns true if network is ready to send on (boolean).

func (*Cmix) RegisterClientErrorCallback ¶

func (c *Cmix) RegisterClientErrorCallback(_ js.Value, args []js.Value) any

RegisterClientErrorCallback registers the callback to handle errors from the long-running threads controlled by StartNetworkFollower and StopNetworkFollower.

Parameters:

• args[0] - Javascript object that has functions that implement the bindings.ClientError interface.

func (*Cmix) RemoveHealthCallback ¶

func (c *Cmix) RemoveHealthCallback(_ js.Value, args []js.Value) any

RemoveHealthCallback removes a health callback using its registration ID.

Parameters:

• args[0] - Callback registration ID (int).

func (*Cmix) SetTrackNetworkPeriod ¶ added in v0.3.0

func (c *Cmix) SetTrackNetworkPeriod(_ js.Value, args []js.Value) any

SetTrackNetworkPeriod allows changing the frequency that follower threads are started.

Note that the frequency of the follower threads affect the power usage of the device following the network.

• Low period -> Higher frequency of polling -> Higher battery usage
• High period -> Lower frequency of polling -> Lower battery usage

This may be used to enable a low power (or battery optimization) mode for the end user.

Suggested values are provided, however there are no guarantees that these values will perfectly fit what the end user's device would require to match the user's expectations:

• Low Power Usage: 5000 milliseconds
• High Power Usage: 1000 milliseconds (default, see cmix.DefaultFollowPeriod

Parameters:

• args[0] - The duration of the period, in milliseconds (int).

func (*Cmix) StartNetworkFollower ¶

func (c *Cmix) StartNetworkFollower(_ js.Value, args []js.Value) any

StartNetworkFollower kicks off the tracking of the network. It starts long- running network threads and returns an object for checking state and stopping those threads.

Call this when returning from sleep and close when going back to sleep.

These threads may become a significant drain on battery when offline, ensure they are stopped if there is no internet access.

Threads Started:

• Network Follower (/network/follow.go) tracks the network events and hands them off to workers for handling.
• Historical Round Retrieval (/network/rounds/historical.go) retrieves data about rounds that are too old to be stored by the client.
• Message Retrieval Worker Group (/network/rounds/retrieve.go) requests all messages in a given round from the gateway of the last nodes.
• Message Handling Worker Group (/network/message/handle.go) decrypts and partitions messages when signals via the Switchboard.
• Health Tracker (/network/health), via the network instance, tracks the state of the network.
• Garbled Messages (/network/message/garbled.go) can be signaled to check all recent messages that could be decoded. It uses a message store on disk for persistence.
• Critical Messages (/network/message/critical.go) ensures all protocol layer mandatory messages are sent. It uses a message store on disk for persistence.
• KeyExchange Trigger (/keyExchange/trigger.go) responds to sent rekeys and executes them.
• KeyExchange Confirm (/keyExchange/confirm.go) responds to confirmations of successful rekey operations.
• Auth Callback (/auth/callback.go) handles both auth confirm and requests.

Parameters:

• args[0] - Timeout when stopping threads in milliseconds (int).

Returns:

• Throws an error if starting the network follower fails.

func (*Cmix) StopNetworkFollower ¶

func (c *Cmix) StopNetworkFollower(js.Value, []js.Value) any

StopNetworkFollower stops the network follower if it is running.

If the network follower is running and this fails, the Cmix object will most likely be in an unrecoverable state and need to be trashed.

Returns:

• Throws an error if the follower is in the wrong state to stop or if it fails to stop.

func (*Cmix) TrackServices ¶

func (c *Cmix) TrackServices(_ js.Value, args []js.Value) any

TrackServices will return, via a callback, the list of services that the backend keeps track of, which is formally referred to as a message.ServiceList. This may be passed into other bindings call that may need context on the available services for this client.

Parameters:

• args[0] - Javascript object that has functions that implement the bindings.TrackServicesCallback interface.

func (*Cmix) TrackServicesWithIdentity ¶ added in v0.1.10

func (c *Cmix) TrackServicesWithIdentity(_ js.Value, args []js.Value) any

TrackServicesWithIdentity will return via a callback the list of services the backend keeps track of for the provided identity. This may be passed into other bindings call which may need context on the available services for this single identity. This will only return services for the given identity.

Parameters:

• args[0] - ID of E2e object in tracker (int).
• args[1] - Javascript object that has functions that implement the bindings.ClientError interface.
• args[2] - Javascript object that has functions that implement the bindings.TrackCompressedServicesCallback, which will be passed the JSON of message.CompressedServiceList.

Returns:

• Throws TypeError if the E2e ID is invalid.

func (*Cmix) WaitForNetwork ¶

func (c *Cmix) WaitForNetwork(_ js.Value, args []js.Value) any

WaitForNetwork will block until either the network is healthy or the passed timeout is reached. It will return true if the network is healthy.

Parameters:

• args[0] - Timeout when stopping threads in milliseconds (int).

Returns a promise:

• A promise that resolves if the network is healthy and rejects if the network is not healthy.

func (*Cmix) WaitForRoundResult ¶

func (c *Cmix) WaitForRoundResult(_ js.Value, args []js.Value) any

WaitForRoundResult allows the caller to get notified if the rounds a message was sent in successfully completed. Under the hood, this uses an API that uses the internal round data, network historical round lookup, and waiting on network events to determine what has (or will) occur.

This function takes the marshaled send report to ensure a memory leak does not occur as a result of both sides of the bindings holding a reference to the same pointer.

roundList is a JSON marshalled bindings.RoundsList or any JSON marshalled send report that inherits a bindings.RoundsList object.

Parameters:

• args[0] - JSON of bindings.RoundsList or JSON of any send report that inherits a bindings.RoundsList object (Uint8Array).
• args[1] - Javascript object that has functions that implement the bindings.MessageDeliveryCallback interface.
• args[2] - Timeout when the callback will return if no state update occurs, in milliseconds (int).

Returns:

• Throws an error if the parameters are invalid or getting round results fails.

func (*Connection) Close ¶

func (c *Connection) Close(js.Value, []js.Value) any

Close deletes this Connection's partner.Manager and releases resources.

Returns:

• Throws an error if closing fails.

func (*Connection) GetId ¶

func (c *Connection) GetId(js.Value, []js.Value) any

GetId returns the ID for this bindings.Connection in the connectionTracker.

Returns:

• Tracker ID (int).

func (*Connection) GetPartner ¶

func (c *Connection) GetPartner(js.Value, []js.Value) any

GetPartner returns the partner.Manager for this Connection.

Returns:

• Marshalled bytes of the partner's id.ID (Uint8Array).

func (*Connection) RegisterListener ¶

func (c *Connection) RegisterListener(_ js.Value, args []js.Value) any

RegisterListener is used for E2E reception and allows for reading data sent from the partner.Manager.

Parameters:

• args[0] - message type from catalog.MessageType (int).
• args[1] - Javascript object that has functions that implement the bindings.Listener interface.

Returns:

• Throws an error is registering the listener fails.

func (*Connection) SendE2E ¶

func (c *Connection) SendE2E(_ js.Value, args []js.Value) any

SendE2E is a wrapper for sending specifically to the Connection's partner.Manager.

Parameters:

• args[0] - Message type from catalog.MessageType (int).
• args[1] - Message payload (Uint8Array).

Returns a promise:

• Resolves to the JSON of the bindings.E2ESendReport, which can be passed into Cmix.WaitForRoundResult to see if the send succeeded (Uint8Array).
• Rejected with an error if sending fails.

func (*DMClient) BlockPartner ¶ added in v0.3.4

func (dmc *DMClient) BlockPartner(_ js.Value, args []js.Value) any

BlockPartner prevents receiving messages and notifications from the partner.

Parameters:

• args[0] - The partner's ed25519.PublicKey key to block (Uint8Array).

Returns a promise that exits upon completion.

func (*DMClient) DeleteMessage ¶ added in v0.3.4

func (dmc *DMClient) DeleteMessage(_ js.Value, args []js.Value) any

DeleteMessage sends a message to the partner to delete a message this user sent. Also deletes it from the local database.

Parameters:

• args[0] - The bytes of the public key of the partner's ED25519 signing key (Uint8Array).
• args[1] - The token used to derive the reception ID for the partner (int).
• args[2] -The bytes of the message.ID of the message to delete. This may be found in the bindings.ChannelSendReport (Uint8Array).
• args[3] - JSON of xxdk.CMIXParams. If left empty bindings.GetDefaultCMixParams will be used internally (Uint8Array).

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*DMClient) ExportPrivateIdentity ¶ added in v0.3.0

func (dmc *DMClient) ExportPrivateIdentity(_ js.Value, args []js.Value) any

ExportPrivateIdentity encrypts and exports the private identity to a portable string.

Parameters:

• args[0] - Password to encrypt the identity with (string).

Returns:

• Encrypted private identity bytes (Uint8Array).
• Throws TypeError if exporting the identity fails.

func (*DMClient) GetBlockedPartners ¶ added in v0.3.4

func (dmc *DMClient) GetBlockedPartners(js.Value, []js.Value) any

GetBlockedPartners returns all partners who are blocked by this user.

Returns:

• JSON of an array of ed25519.PublicKey (Uint8Array)

Example return:

[
  "TYWuCfyGBjNWDtl/Roa6f/o206yYPpuB6sX2kJZTe98=",
  "4JLRzgtW1SZ9c5pE+v0WwrGPj1t19AuU6Gg5IND5ymA=",
  "CWDqF1bnhulW2pko+zgmbDZNaKkmNtFdUgY4bTm2DhA="
]

func (*DMClient) GetDatabaseName ¶ added in v0.3.0

func (dmc *DMClient) GetDatabaseName(js.Value, []js.Value) any

GetDatabaseName returns the storage tag, so users listening to the database can separately listen and read updates there.

Returns:

• The storage tag (string).

func (*DMClient) GetID ¶ added in v0.3.0

func (dmc *DMClient) GetID(js.Value, []js.Value) any

GetID returns the ECDH Public Key for this DMClient in the DMClient tracker.

Returns:

• Tracker ID (int).

func (*DMClient) GetIdentity ¶ added in v0.3.0

func (dmc *DMClient) GetIdentity(js.Value, []js.Value) any

GetIdentity returns the public identity associated with this client.

Returns:

• JSON codename.Identity (Uint8Array).

func (*DMClient) GetNickname ¶ added in v0.3.0

func (dmc *DMClient) GetNickname(_ js.Value, _ []js.Value) any

GetNickname gets the nickname associated with this DM user. Throws an error if no nickname is set.

Returns:

• The nickname (string).
• Throws an error if the channel has no nickname set.

func (*DMClient) GetNotificationLevel ¶ added in v0.3.4

func (dmc *DMClient) GetNotificationLevel(_ js.Value, args []js.Value) any

GetNotificationLevel gets the notification level for a given DM partner's public key

Parameters:

• args[0] - The partner's ed25519.PublicKey (Uint8Array)

Returns:

• The dm.NotificationLevel of the DM conversation (int).

Returns a promise:

• Resolves to the dm.NotificationLevel of the DM conversation (int).
• Rejected with an error if getting the notification level fails.

func (*DMClient) GetPublicKey ¶ added in v0.3.0

func (dmc *DMClient) GetPublicKey(js.Value, []js.Value) any

GetPublicKey returns the bytes of the public key for this client.

Returns:

• Public key (Uint8Array).

func (*DMClient) GetShareURL ¶ added in v0.3.3

func (dmc *DMClient) GetShareURL(_ js.Value, args []js.Value) any

GetShareURL generates a URL that can be used to share a URL to initiate d direct messages with this user.

Parameters:

• args[0] - The URL to append the DM info to (string).

Returns:

• JSON of DMShareURL (Uint8Array).
• Throws an exception on error.

func (*DMClient) GetToken ¶ added in v0.3.0

func (dmc *DMClient) GetToken(js.Value, []js.Value) any

GetToken returns the DM token of this client.

func (*DMClient) IsBlocked ¶ added in v0.3.3

func (dmc *DMClient) IsBlocked(_ js.Value, args []js.Value) any

IsBlocked indicates if the given partner is blocked.

Parameters:

• args[0] - The partner's ed25519.PublicKey public key to check (Uint8Array).

Returns:

• boolean

func (*DMClient) Send ¶ added in v0.3.0

func (dmc *DMClient) Send(_ js.Value, args []js.Value) any

Send is used to send a raw message. In general, it should be wrapped in a function that defines the wire protocol.

If the final message, before being sent over the wire, is too long, this will return an error. Due to the underlying encoding using compression, it is not possible to define the largest payload that can be sent, but it will always be possible to send a payload of 802 bytes at minimum.

The meaning of leaseTimeMS depends on the use case.

Parameters:

• args[0] - Marshalled bytes of the partner pubkyey (Uint8Array).
• args[1] - The token used to derive the reception ID for the partner (int).
• args[2] - The message type of the message. This will be a valid dm.MessageType (int)
• args[3] - The contents of the message. This need not be of data type string, as the message could be a specified format that the channel may recognize (Uint8Array)
• args[4] - The bytes of the message.ID of the message you wish to react to. This may be found in the bindings.ChannelSendReport if replying to your own. Alternatively, if reacting to another user's message, you may retrieve it via the bindings.ChannelMessageReceptionCallback registered using ChannelsManager.RegisterReceiveHandler (Uint8Array).
• args[5] - JSON of xxdk.CMIXParams. If left empty bindings.GetDefaultCMixParams will be used internally (Uint8Array).

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*DMClient) SendInvite ¶ added in v0.3.4

func (dmc *DMClient) SendInvite(_ js.Value, args []js.Value) any

SendInvite is used to send to a DM partner an invitation to another channel.

If the channel ID for the invitee channel is not recognized by the Manager, then an error will be returned.

Parameters:

• args[0] - The bytes of the public key of the partner's ED25519 signing key (Uint8Array).
• args[1] - The token used to derive the reception ID for the partner (int).
• args[2] - JSON of the invitee channel id.ID. This can be retrieved from GetChannelJSON. (Uint8Array).
• args[3] - The contents of the message. The message should be at most 510 bytes. This is expected to be Unicode, and thus a string data type is expected.
• args[4] - The URL to append the channel info to.
• args[5] - A JSON marshalled xxdk.CMIXParams. This may be empty, and GetDefaultCMixParams will be used internally.

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*DMClient) SendReaction ¶ added in v0.3.0

func (dmc *DMClient) SendReaction(_ js.Value, args []js.Value) any

SendReaction is used to send a reaction to a message over a channel. The reaction must be a single emoji with no other characters, and will be rejected otherwise. Users will drop the reaction if they do not recognize the reactTo message.

Parameters:

• args[0] - The bytes of the public key of the partner's ED25519 signing key (Uint8Array).
• args[1] - The token used to derive the reception ID for the partner (int).
• args[2] - The user's reaction. This should be a single emoji with no other characters. As such, a Unicode string is expected (string).
• args[3] - The bytes of the message.ID of the message you wish to react to. This may be found in the bindings.ChannelSendReport if replying to your own. Alternatively, if reacting to another user's message, you may retrieve it via the bindings.ChannelMessageReceptionCallback registered using ChannelsManager.RegisterReceiveHandler (Uint8Array).
• args[4] - JSON of xxdk.CMIXParams. If left empty bindings.GetDefaultCMixParams will be used internally (Uint8Array).

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*DMClient) SendReply ¶ added in v0.3.0

func (dmc *DMClient) SendReply(_ js.Value, args []js.Value) any

SendReply is used to send a formatted direct message reply.

If the message ID that the reply is sent to does not exist, then the other side will post the message as a normal message and not as a reply.

The message will auto delete leaseTime after the round it is sent in, lasting forever if bindings.ValidForever is used.

Parameters:

• args[0] - The bytes of the public key of the partner's ED25519 signing key (Uint8Array).
• args[1] - The token used to derive the reception ID for the partner (int).
• args[2] - The contents of the reply message. The message should be at most 510 bytes. This is expected to be Unicode, and thus a string data type is expected (string).
• args[3] - The bytes of the message.ID of the message you wish to reply to. This may be found in the bindings.ChannelSendReport if replying to your own. Alternatively, if reacting to another user's message, you may retrieve it via the bindings.ChannelMessageReceptionCallback registered using ChannelsManager.RegisterReceiveHandler (Uint8Array).
• args[4] - The lease of the message. This will be how long the message is valid until, in milliseconds. As per the channels.Manager documentation, this has different meanings depending on the use case. These use cases may be generic enough that they will not be enumerated here (int).
• args[5] - JSON of [xxdk.CMIXParams.] If left empty, then GetDefaultCMixParams will be used internally (Uint8Array).

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*DMClient) SendSilent ¶ added in v0.3.4

func (dmc *DMClient) SendSilent(_ js.Value, args []js.Value) any

SendSilent is used to send to a channel a message with no notifications. Its primary purpose is to communicate new nicknames without calling [Send].

It takes no payload intentionally as the message should be very lightweight.

Parameters:

• args[0] - The bytes of the public key of the partner's ED25519 signing key (Uint8Array).
• args[1] - The token used to derive the reception ID for the partner (int).
• args[2] - JSON of xxdk.CMIXParams. If left empty bindings.GetDefaultCMixParams will be used internally (Uint8Array).

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*DMClient) SendText ¶ added in v0.3.0

func (dmc *DMClient) SendText(_ js.Value, args []js.Value) any

SendText is used to send a formatted direct message to a user.

Parameters:

• args[0] - The bytes of the public key of the partner's ED25519 signing key (Uint8Array).
• args[1] - The token used to derive the reception ID for the partner (int).
• args[2] - The contents of the message. The message should be at most 510 bytes. This is expected to be Unicode, and thus a string data type is expected (string).
• args[3] - The lease of the message. This will be how long the message is valid until, in milliseconds. As per the channels.Manager documentation, this has different meanings depending on the use case. These use cases may be generic enough that they will not be enumerated here (int).
• args[3] - JSON of [xxdk.CMIXParams.] If left empty, then GetDefaultCMixParams will be used internally (Uint8Array).

Returns a promise:

• Resolves to the JSON of bindings.ChannelSendReport (Uint8Array).
• Rejected with an error if sending fails.

func (*DMClient) SetMobileNotificationsLevel ¶ added in v0.3.4

func (dmc *DMClient) SetMobileNotificationsLevel(_ js.Value,
	args []js.Value) any

SetMobileNotificationsLevel sets the notification level for the given DM conversation partner.

Parameters:

• args[0] - The partner's ed25519.PublicKey (Uint8Array).
• args[1] - The dm.NotificationLevel to set for the DM conversation (int).

Returns a promise:

• Resolves on success.
• Rejected with an error if setting the notification level fails.

func (*DMClient) SetNickname ¶ added in v0.3.0

func (dmc *DMClient) SetNickname(_ js.Value, args []js.Value) any

SetNickname sets the nickname to use for this user.

Parameters:

• args[0] - The nickname to set (string).

Returns:

• Throws an error if setting the nickname fails.

func (*DMClient) UnblockPartner ¶ added in v0.3.4

func (dmc *DMClient) UnblockPartner(_ js.Value, args []js.Value) any

UnblockPartner unblocks a blocked partner to allow DM messages.

Parameters:

• args[0] - The partner's ed25519.PublicKey to unblock (Uint8Array).

func (*DbCipher) Decrypt ¶ added in v0.3.4

func (c *DbCipher) Decrypt(_ js.Value, args []js.Value) any

Decrypt will decrypt the passed in encrypted value. The plaintext will be returned by this function. Any padding will be discarded within this function.

Parameters:

• args[0] - the encrypted data returned by DbCipher.Encrypt (String).

Returns:

• The plaintext of the ciphertext passed in (Uint8Array).
• Throws an error if it fails to encrypt the plaintext.

func (*DbCipher) Encrypt ¶ added in v0.3.4

func (c *DbCipher) Encrypt(_ js.Value, args []js.Value) any

Encrypt will encrypt the raw data. It will return a ciphertext. Padding is done on the plaintext so all encrypted data looks uniform at rest.

Parameters:

• args[0] - The data to be encrypted (Uint8Array). This must be smaller than the block size passed into NewDatabaseCipher. If it is larger, this will return an error.

Returns:

• The ciphertext of the plaintext passed in (String).
• Throws an error if it fails to encrypt the plaintext.

func (*DbCipher) GetID ¶ added in v0.3.4

func (c *DbCipher) GetID(js.Value, []js.Value) any

GetID returns the ID for this DbCipher in the DbCipherTracker.

Returns:

• Tracker ID (int).

func (*DbCipher) MarshalJSON ¶ added in v0.3.4

func (c *DbCipher) MarshalJSON(js.Value, []js.Value) any

MarshalJSON marshals the cipher into valid JSON.

Returns:

• JSON of the cipher (Uint8Array).
• Throws an error if marshalling fails.

func (*DbCipher) UnmarshalJSON ¶ added in v0.3.4

func (c *DbCipher) UnmarshalJSON(_ js.Value, args []js.Value) any

UnmarshalJSON unmarshalls JSON into the cipher.

Note that this function does not transfer the internal RNG. Use indexedDb.NewCipherFromJSON to properly reconstruct a cipher from JSON.

Parameters:

• args[0] - JSON data to unmarshal (Uint8Array).

Returns:

• JSON of the cipher (Uint8Array).
• Throws an error if marshalling fails.

func (*DummyTraffic) GetStatus ¶

func (dt *DummyTraffic) GetStatus(js.Value, []js.Value) any

GetStatus returns the current state of the DummyTraffic manager's sending thread. Note that the status returned here may lag behind a user's earlier call to pause the sending thread. This is a result of a small delay (see DummyTraffic.Pause for more details)

Returns:

• Returns true ([dummy.Running]) if the sending thread is sending messages and false ([dummy.Paused]) if the sending thread is not sending messages.

func (*DummyTraffic) Pause ¶ added in v0.3.0

func (dt *DummyTraffic) Pause(js.Value, []js.Value) any

Pause will pause the DummyTraffic's sending thread, meaning messages will no longer be sent. After calling Pause, the sending thread may only be resumed by calling Resume.

There may be a small delay between this call and the pause taking effect. This is because Pause will not cancel the thread when it is in the process of sending messages, but will instead wait for that thread to complete. The thread will then be prevented from beginning another round of sending.

Returns:

• Throws an error if it fails to send a pause signal to the sending thread.

func (*DummyTraffic) Start ¶ added in v0.3.0

func (dt *DummyTraffic) Start(js.Value, []js.Value) any

Start will start up the DummyTraffic's sending thread, meaning messages will be sent. This should be called after calling NewDummyTrafficManager, by default the thread is paused. This may also be called after a call to DummyTraffic.Pause.

This will re-initialize the sending thread with a new randomly generated interval between sending dummy messages. This means that there is zero guarantee that the sending interval prior to pausing will be the same sending interval after a call to Start.

Returns:

• Throws an error if it fails to send a start signal to the sending thread.

func (*E2e) AddPartnerCallback ¶

func (e *E2e) AddPartnerCallback(_ js.Value, args []js.Value) any

AddPartnerCallback adds a new callback that overrides the generic auth callback for the given partner ID.

Parameters:

• args[0] - Marshalled bytes of the partner id.ID (Uint8Array).
• args[1] - Javascript object that has functions that implement the bindings.AuthCallbacks interface.

Returns:

• Throws TypeError if the id.ID cannot be unmarshalled.

func (*E2e) AddService ¶

func (e *E2e) AddService(_ js.Value, args []js.Value) any

AddService adds a service for all partners of the given tag, which will call back on the given processor. These can be sent to using the tag fields in the Params object.

Passing nil for the processor allows you to create a service that is never called but will be visible by notifications. Processes added this way are generally not end-to-end encrypted messages themselves, but other protocols that piggyback on e2e relationships to start communication.

Parameters:

• args[0] - tag for the service (string).
• args[1] - Javascript object that has functions that implement the bindings.Processor interface.

Returns:

• Throws TypeError if registering the service fails.

func (*E2e) CallAllReceivedRequests ¶

func (e *E2e) CallAllReceivedRequests(js.Value, []js.Value) any

CallAllReceivedRequests will iterate through all pending contact requests and replay them on the callbacks.

func (*E2e) Confirm ¶

func (e *E2e) Confirm(_ js.Value, args []js.Value) any

Confirm sends a confirmation for a received request. It can only be called once. This both sends keying material to the other party and creates a channel in the e2e handler, after which e2e messages can be sent to the partner using E2e.SendE2E.

The round the request is initially sent on will be returned, but the request will be listed as a critical message, so the underlying cMix client will auto resend it in the event of failure.

A confirmation cannot be sent for a contact who has not sent a request or who is already a partner. This can only be called once for a specific contact. The confirmation sends as a critical message; if the round it sends on fails, it will be auto resent by the cMix client.

If the confirmation must be resent, use E2e.ReplayConfirm.

Parameters:

• args[0] - Marshalled bytes of the partner contact.Contact (Uint8Array).

Returns a promise:

• Resolves to the ID of the round (int).
• Rejected with an error if sending the confirmation fails.

func (*E2e) DeleteAllRequests ¶

func (e *E2e) DeleteAllRequests(js.Value, []js.Value) any

DeleteAllRequests clears all requests from auth storage.

Returns:

• Throws TypeError if the deletion fails.

func (*E2e) DeleteContact ¶

func (e *E2e) DeleteContact(_ js.Value, args []js.Value) any

DeleteContact removes a partner from E2e's storage.

Parameters:

• args[0] - Marshalled bytes of the partner id.ID (Uint8Array).

Returns:

• Throws TypeError if deleting the partner fails.

func (*E2e) DeletePartnerCallback ¶

func (e *E2e) DeletePartnerCallback(_ js.Value, args []js.Value) any

DeletePartnerCallback deletes the callback that overrides the generic auth callback for the given partner ID.

Parameters:

• args[0] - Marshalled bytes of the partner id.ID (Uint8Array).

Returns:

• Throws TypeError if the id.ID cannot be unmarshalled.

func (*E2e) DeleteReceiveRequests ¶

func (e *E2e) DeleteReceiveRequests(js.Value, []js.Value) any

DeleteReceiveRequests clears all received requests from auth storage.

Returns:

• Throws TypeError if the deletion fails.

func (*E2e) DeleteRequest ¶

func (e *E2e) DeleteRequest(_ js.Value, args []js.Value) any

DeleteRequest deletes sent or received requests for a specific partner ID.

Parameters:

• args[0] - Marshalled bytes of the partner contact.Contact (Uint8Array).

Returns:

• Throws TypeError if the deletion fails.

func (*E2e) DeleteSentRequests ¶

func (e *E2e) DeleteSentRequests(js.Value, []js.Value) any

DeleteSentRequests clears all sent requests from auth storage.

Returns:

• Throws TypeError if the deletion fails.

func (*E2e) FirstPartitionSize ¶

func (e *E2e) FirstPartitionSize(js.Value, []js.Value) any

FirstPartitionSize returns the max partition payload size for the first payload.

Returns:

• Max partition payload size (int).

func (*E2e) GetAllPartnerIDs ¶

func (e *E2e) GetAllPartnerIDs(js.Value, []js.Value) any

GetAllPartnerIDs returns a list of all partner IDs that the user has an E2E relationship with.

Returns:

• JSON of array of id.ID (Uint8Array).
• Throws TypeError if getting partner IDs fails.

func (*E2e) GetContact ¶

func (e *E2e) GetContact(js.Value, []js.Value) any

GetContact returns a contact.Contact object for the E2e bindings.ReceptionIdentity.

Returns:

• Marshalled bytes of contact.Contact (Uint8Array).

func (*E2e) GetHistoricalDHPrivkey ¶

func (e *E2e) GetHistoricalDHPrivkey(js.Value, []js.Value) any

GetHistoricalDHPrivkey returns the user's marshalled historical DH private key.

Returns:

• JSON of cyclic.Int (Uint8Array).
• Throws TypeError if getting the key fails.

func (*E2e) GetHistoricalDHPubkey ¶

func (e *E2e) GetHistoricalDHPubkey(js.Value, []js.Value) any

GetHistoricalDHPubkey returns the user's marshalled historical DH public key. key.

Returns:

• JSON of cyclic.Int (Uint8Array).
• Throws TypeError if getting the key fails.

func (*E2e) GetID ¶

func (e *E2e) GetID(js.Value, []js.Value) any

GetID returns the ID for this E2e in the E2e tracker.

Returns:

• Tracker ID (int).

func (*E2e) GetReceivedRequest ¶

func (e *E2e) GetReceivedRequest(_ js.Value, args []js.Value) any

GetReceivedRequest returns a contact if there is a received request for it.

Parameters:

• args[0] - Marshalled bytes of the partner contact.Contact (Uint8Array).

Returns:

• Marshalled bytes of contact.Contact (Uint8Array).
• Throws TypeError if getting the received request fails.

func (*E2e) GetReceptionID ¶

func (e *E2e) GetReceptionID(js.Value, []js.Value) any

GetReceptionID returns the marshalled default IDs.

Returns:

• Marshalled bytes of id.ID (Uint8Array).

func (*E2e) GetUdAddressFromNdf ¶

func (e *E2e) GetUdAddressFromNdf(js.Value, []js.Value) any

GetUdAddressFromNdf retrieve the User Discovery's network address fom the NDF.

Returns:

• User Discovery's address (string).

func (*E2e) GetUdCertFromNdf ¶

func (e *E2e) GetUdCertFromNdf(js.Value, []js.Value) any

GetUdCertFromNdf retrieves the User Discovery's TLS certificate from the NDF.

Returns:

• Public certificate in PEM format (Uint8Array).

func (*E2e) GetUdContactFromNdf ¶

func (e *E2e) GetUdContactFromNdf(js.Value, []js.Value) any

GetUdContactFromNdf assembles the User Discovery's contact file from the data within the NDF.

Returns

• Marshalled bytes of contact.Contact (Uint8Array).
• Throws an error if the contact file cannot be loaded.

func (*E2e) HasAuthenticatedChannel ¶

func (e *E2e) HasAuthenticatedChannel(_ js.Value, args []js.Value) any

HasAuthenticatedChannel returns true if an authenticated channel with the partner exists, otherwise returns false.

Parameters:

• args[0] - Marshalled bytes of id.ID (Uint8Array).

Returns:

• Existence of authenticated channel (boolean).
• Throws TypeError if unmarshalling the ID or getting the channel fails.

func (*E2e) PartitionSize ¶

func (e *E2e) PartitionSize(_ js.Value, args []js.Value) any

PartitionSize returns the partition payload size for the given payload index. The first payload is index 0.

Parameters:

• args[0] - Payload index (int).

Returns:

• Partition payload size (int).

func (*E2e) PayloadSize ¶

func (e *E2e) PayloadSize(js.Value, []js.Value) any

PayloadSize returns the max payload size for a partitionable E2E message.

Returns:

• Max payload size (int).

func (*E2e) RegisterListener ¶

func (e *E2e) RegisterListener(_ js.Value, args []js.Value) any

RegisterListener registers a new listener.

Parameters:

• args[0] - Marshalled byte of the user id.ID who sends messages to this user that this function will register a listener for (Uint8Array).
• args[1] - Message type from catalog.MessageType you want to listen for (int).
• args[2] - Javascript object that has functions that implement the bindings.Listener interface; do not pass nil as the listener.

Returns:

• Throws TypeError if registering the service fails.

func (*E2e) RemoveService ¶

func (e *E2e) RemoveService(_ js.Value, args []js.Value) any

RemoveService removes all services for the given tag.

Parameters:

• args[0] - Tag of services to remove (string).

Returns:

• Throws TypeError if removing the services fails.

func (*E2e) ReplayConfirm ¶

func (e *E2e) ReplayConfirm(_ js.Value, args []js.Value) any

ReplayConfirm resends a confirmation to the partner. It will fail to send if the send relationship with the partner has already ratcheted.

The confirmation sends as a critical message; if the round it sends on fails, it will be auto resent by the cMix client.

This will not be useful if either side has ratcheted.

Parameters:

• args[0] - Marshalled bytes of the partner contact.Contact (Uint8Array).

Returns a promise:

• Resolves to the ID of the round (int).
• Rejected with an error if resending the confirmation fails.

func (*E2e) Request ¶

func (e *E2e) Request(_ js.Value, args []js.Value) any

Request sends a contact request from the user identity in the imported E2e structure to the passed contact, as well as the passed facts (it will error if they are too long).

The other party must accept the request by calling E2e.Confirm to be able to send messages using E2e.SendE2E. When the other party does so, the "confirm" callback will get called.

The round the request is initially sent on will be returned, but the request will be listed as a critical message, so the underlying cMix client will auto resend it in the event of failure.

A request cannot be sent for a contact who has already received a request or who is already a partner.

The request sends as a critical message, if the round it sends on fails, it will be auto resent by the cMix client.

Parameters:

• args[0] - Marshalled bytes of the partner contact.Contact (Uint8Array).
• args[1] - JSON of fact.FactList (Uint8Array).

Returns a promise:

• Resolves to the ID of the round (int).
• Rejected with an error if sending the request fails.

func (*E2e) Reset ¶

func (e *E2e) Reset(_ js.Value, args []js.Value) any

Reset sends a contact reset request from the user identity in the imported e2e structure to the passed contact, as well as the passed facts (it will error if they are too long).

This deletes all traces of the relationship with the partner from e2e and create a new relationship from scratch.

The round the reset is initially sent on will be returned, but the request will be listed as a critical message, so the underlying cMix client will auto resend it in the event of failure.

A request cannot be sent for a contact who has already received a request or who is already a partner.

Parameters:

• args[0] - Marshalled bytes of the partner contact.Contact (Uint8Array).

Returns a promise:

• Resolves to the ID of the round (int).
• Rejected with an error if sending the reset fails.

func (*E2e) SecondPartitionSize ¶

func (e *E2e) SecondPartitionSize(js.Value, []js.Value) any

SecondPartitionSize returns the max partition payload size for all payloads after the first payload.

Returns:

• Max payload size (int).

func (*E2e) SendE2E ¶

func (e *E2e) SendE2E(_ js.Value, args []js.Value) any

SendE2E send a message containing the payload to the recipient of the passed message type, per the given parameters--encrypted with end-to-end encryption.

Parameters:

• args[0] - Message type from catalog.MessageType (int).
• args[1] - Marshalled bytes of id.ID (Uint8Array).
• args[2] - Message payload (Uint8Array).
• args[3] - JSON xxdk.E2EParams (Uint8Array).

Returns a promise:

• Resolves to the JSON of the bindings.E2ESendReport, which can be passed into Cmix.WaitForRoundResult to see if the send succeeded (Uint8Array).
• Rejected with an error if sending fails.

func (*E2e) VerifyOwnership ¶

func (e *E2e) VerifyOwnership(_ js.Value, args []js.Value) any

VerifyOwnership checks if the received ownership proof is valid.

Parameters:

• args[0] - Marshalled bytes of the received contact.Contact (Uint8Array).
• args[1] - Marshalled bytes of the verified contact.Contact (Uint8Array).
• args[2] - ID of E2e object in tracker (int).

Returns:

• Returns true if the ownership is valid (boolean).
• Throws TypeError if loading the parameters fails.

func (*FilePartTracker) GetNumParts ¶

func (fpt *FilePartTracker) GetNumParts(js.Value, []js.Value) any

GetNumParts returns the total number of file parts in the transfer.

Returns:

• Number of parts (int).

func (*FilePartTracker) GetPartStatus ¶

func (fpt *FilePartTracker) GetPartStatus(_ js.Value, args []js.Value) any

GetPartStatus returns the status of the file part with the given part number.

The possible values for the status are:

• 0 < Part does not exist
• 0 = unsent
• 1 = arrived (sender has sent a part, and it has arrived)
• 2 = received (receiver has received a part)

Parameters:

• args[0] - Index of part (int).

Returns:

• Part status (int).

func (*FileTransfer) CloseSend ¶

func (f *FileTransfer) CloseSend(_ js.Value, args []js.Value) any

CloseSend deletes a file from the internal storage once a transfer has completed or reached the retry limit. Returns an error if the transfer has not run out of retries.

This function should be called once a transfer completes or errors out (as reported by the progress callback).

Parameters:

• args[0] - File transfer fileTransfer.TransferID (Uint8Array).

Returns:

• Throws an error if the file transfer is incomplete.

func (*FileTransfer) MaxFileNameLen ¶

func (f *FileTransfer) MaxFileNameLen(js.Value, []js.Value) any

MaxFileNameLen returns the max number of bytes allowed for a file name.

Returns:

• Max file name length (int).

func (*FileTransfer) MaxFileSize ¶

func (f *FileTransfer) MaxFileSize(js.Value, []js.Value) any

MaxFileSize returns the max number of bytes allowed for a file.

Returns:

• Max file size (int).

func (*FileTransfer) MaxFileTypeLen ¶

func (f *FileTransfer) MaxFileTypeLen(js.Value, []js.Value) any

MaxFileTypeLen returns the max number of bytes allowed for a file type.

Returns:

• Max file type length (int).

func (*FileTransfer) MaxPreviewSize ¶

func (f *FileTransfer) MaxPreviewSize(js.Value, []js.Value) any

MaxPreviewSize returns the max number of bytes allowed for a file preview.

Returns:

• Max preview size (int).

func (*FileTransfer) Receive ¶

func (f *FileTransfer) Receive(_ js.Value, args []js.Value) any

Receive returns the full file on the completion of the transfer. It deletes internal references to the data and unregisters any attached progress callbacks. Returns an error if the transfer is not complete, the full file cannot be verified, or if the transfer cannot be found.

Receive can only be called once the progress callback returns that the file transfer is complete.

Parameters:

• args[0] - File transfer fileTransfer.TransferID (Uint8Array).

Returns:

• File contents (Uint8Array).
• Throws an error the file transfer is incomplete or Receive has already been called.

func (*FileTransfer) RegisterReceivedProgressCallback ¶

func (f *FileTransfer) RegisterReceivedProgressCallback(
	_ js.Value, args []js.Value) any

RegisterReceivedProgressCallback allows for the registration of a callback to track the progress of an individual received file transfer.

This should be done when a new transfer is received on the ReceiveCallback.

Parameters:

• args[0] - File transfer fileTransfer.TransferID (Uint8Array).
• args[1] - Javascript object that has functions that implement the bindings.FileTransferReceiveProgressCallback interface.
• args[2] - Duration, in milliseconds, to wait between progress callbacks triggering (int).

Returns:

• Throws an error if registering the callback fails.

func (*FileTransfer) RegisterSentProgressCallback ¶

func (f *FileTransfer) RegisterSentProgressCallback(
	_ js.Value, args []js.Value) any

RegisterSentProgressCallback allows for the registration of a callback to track the progress of an individual sent file transfer.

SentProgressCallback is auto registered on Send; this function should be called when resuming clients or registering extra callbacks.

Parameters:

• args[0] - File transfer fileTransfer.TransferID (Uint8Array).
• args[1] - Javascript object that has functions that implement the bindings.FileTransferSentProgressCallback interface.
• args[2] - Duration, in milliseconds, to wait between progress callbacks triggering (int).

Returns:

• Throws an error if registering the callback fails.

func (*FileTransfer) Send ¶

func (f *FileTransfer) Send(_ js.Value, args []js.Value) any

Send is the bindings-level function for sending a file.

Parameters:

• args[0] - JSON of bindings.FileSend (Uint8Array).
• args[1] - Marshalled bytes of the recipient id.ID (Uint8Array).
• args[2] - Number of retries allowed (float).
• args[3] - Javascript object that has functions that implement the bindings.FileTransferSentProgressCallback interface.
• args[4] - Duration, in milliseconds, to wait between progress callbacks triggering (int).

Returns a promise:

• Resolves to a unique ID for this file transfer (Uint8Array).
• Rejected with an error if sending fails.

func (*Group) GetCreatedMS ¶

func (g *Group) GetCreatedMS(js.Value, []js.Value) any

GetCreatedMS returns the time the group was created in milliseconds. This is also the time the group requests were sent.

Returns:

• The time the group was created, in milliseconds (int).

func (*Group) GetCreatedNano ¶

func (g *Group) GetCreatedNano(js.Value, []js.Value) any

GetCreatedNano returns the time the group was created in nanoseconds. This is also the time the group requests were sent.

Returns:

• The time the group was created, in nanoseconds (int).

func (*Group) GetID ¶

func (g *Group) GetID(js.Value, []js.Value) any

GetID return the 33-byte unique group ID. This represents the id.ID object.

Returns:

• Marshalled bytes of the group id.ID (Uint8Array).

func (*Group) GetInitMessage ¶

func (g *Group) GetInitMessage(js.Value, []js.Value) any

GetInitMessage returns initial message sent with the group request.

Returns:

• Initial group message contents (Uint8Array).

func (*Group) GetMembership ¶

func (g *Group) GetMembership(js.Value, []js.Value) any

GetMembership retrieves a list of group members. The list is in order; the first contact is the leader/creator of the group. All subsequent members are ordered by their ID.

Returns:

• JSON of group.Membership (Uint8Array).
• Throws an error if marshalling fails.

func (*Group) GetName ¶

func (g *Group) GetName(js.Value, []js.Value) any

GetName returns the name set by the user for the group.

Returns:

• Group name (Uint8Array).

func (*Group) Serialize ¶

func (g *Group) Serialize(js.Value, []js.Value) any

Serialize serializes the Group.

Returns:

• Byte representation of the Group (Uint8Array).

func (*GroupChat) GetGroup ¶

func (g *GroupChat) GetGroup(_ js.Value, args []js.Value) any

GetGroup returns the group with the group ID. If no group exists, then the error "failed to find group" is returned.

Parameters:

• args[0] - The marshalled bytes of the group id.ID (Uint8Array). This can be found in the report returned by GroupChat.MakeGroup.

Returns:

• Javascript representation of the GroupChat object.
• Throws an error if getting the group fails.

func (*GroupChat) GetGroups ¶

func (g *GroupChat) GetGroups(js.Value, []js.Value) any

GetGroups returns a list of group IDs that the user is a member of.

Returns:

• JSON of array of id.ID representing all group ID's (Uint8Array).
• Throws an error if getting the groups fails.

func (*GroupChat) JoinGroup ¶

func (g *GroupChat) JoinGroup(_ js.Value, args []js.Value) any

JoinGroup allows a user to join a group when a request is received. If an error is returned, handle it properly first; you may then retry later with the same trackedGroupId.

Parameters:

• args[0] - The result of calling Group.Serialize on any bindings.Group object returned over the bindings (Uint8Array).

Returns:

• Throws an error if joining the group fails.

func (*GroupChat) LeaveGroup ¶

func (g *GroupChat) LeaveGroup(_ js.Value, args []js.Value) any

LeaveGroup deletes a group so a user no longer has access.

Parameters:

• args[0] - The marshalled bytes of the group id.ID (Uint8Array). This can be found in the report returned by GroupChat.MakeGroup.

Returns:

• Throws an error if leaving the group fails.

func (*GroupChat) MakeGroup ¶

func (g *GroupChat) MakeGroup(_ js.Value, args []js.Value) any

MakeGroup creates a new group and sends a group request to all members in the group.

Parameters:

• args[0] - JSON of array of id.ID; it contains the IDs of members the user wants to add to the group (Uint8Array).
• args[1] - The initial message sent to all members in the group. This is an optional parameter and may be nil (Uint8Array).
• args[2] - The name of the group decided by the creator. This is an optional parameter and may be nil. If nil the group will be assigned the default name (Uint8Array).

Returns a promise:

• Resolves to the JSON of the bindings.GroupReport, which can be passed into Cmix.WaitForRoundResult to see if the send succeeded (Uint8Array).
• Rejected with an error if making the group fails.

func (*GroupChat) NumGroups ¶

func (g *GroupChat) NumGroups(js.Value, []js.Value) any

NumGroups returns the number of groups the user is a part of.

Returns:

• Number of groups (int).

func (*GroupChat) ResendRequest ¶

func (g *GroupChat) ResendRequest(_ js.Value, args []js.Value) any

ResendRequest resends a group request to all members in the group.

Parameters:

• args[0] - The marshalled bytes of the group id.ID (Uint8Array). This can be found in the report returned by GroupChat.MakeGroup.

Returns a promise:

• Resolves to the JSON of the bindings.GroupReport, which can be passed into Cmix.WaitForRoundResult to see if the send succeeded (Uint8Array).
• Rejected with an error if resending the request fails.

func (*GroupChat) Send ¶

func (g *GroupChat) Send(_ js.Value, args []js.Value) any

Send is the bindings-level function for sending to a group.

Parameters:

• args[0] - The marshalled bytes of the group id.ID (Uint8Array). This can be found in the report returned by GroupChat.MakeGroup.
• args[1] - The message that the user wishes to send to the group (Uint8Array).
• args[2] - The tag associated with the message (string). This tag may be empty.

Returns a promise:

• Resolves to the JSON of the bindings.GroupSendReport, which can be passed into Cmix.WaitForRoundResult to see if the send succeeded (Uint8Array).
• Rejected with an error if sending the message to the group fails.

func (*KeyChangedByRemoteCallback) Callback ¶ added in v0.3.4

func (k *KeyChangedByRemoteCallback) Callback(key string, old, new []byte,
	opType int8)

func (*MapChangedByRemoteCallback) Callback ¶ added in v0.3.4

func (m *MapChangedByRemoteCallback) Callback(mapName string,
	editsJSON []byte)

func (*Notifications) AddToken ¶ added in v0.3.4

func (n *Notifications) AddToken(_ js.Value, args []js.Value) any

AddToken implements bindings.Notifications.AddToken.

Parameters:

• args[0] - newToken string
• args[1] - app string

Returns nothing or an error (throwable)

func (*Notifications) GetID ¶ added in v0.3.4

func (n *Notifications) GetID(js.Value, []js.Value) any

GetID returns the bindings ID for the bindings.Notifications object

func (*Notifications) GetMaxState ¶ added in v0.3.4

func (n *Notifications) GetMaxState(_ js.Value, args []js.Value) any

GetMaxState implements bindings.Notifications.GetMaxState

Returns the current maxState integer

func (*Notifications) RemoveToken ¶ added in v0.3.4

func (n *Notifications) RemoveToken(_ js.Value, args []js.Value) any

RemoveToken implements bindings.Notifications.RemoveToken.

Returns nothing or throws an error.

func (*Notifications) SetMaxState ¶ added in v0.3.4

func (n *Notifications) SetMaxState(_ js.Value, args []js.Value) any

SetMaxState implements bindings.Notifications.SetMaxState

Parameters:

• args[0] - maxState integer

Returns nothing or throws an error

func (*RemoteKV) Delete ¶ added in v0.3.4

func (r *RemoteKV) Delete(_ js.Value, args []js.Value) any

Delete removes a given key from the data store.

Parameters:

• args[0] - key to access, a string
• args[1] - version, an integer

Returns a promise:

• Rejected with an access error. Note: File does not exist errors are returned whent key is not set.

func (*RemoteKV) DeleteMapElement ¶ added in v0.3.4

func (r *RemoteKV) DeleteMapElement(_ js.Value, args []js.Value) any

DeleteMapElement removes a versioned map element from the KV.

Parameters:

• args[0] - the mapName string
• args[1] - the elementKey string
• args[2] - the version int

Returns a promise with an error if any or the json of the deleted [versioned.Object], e.g.:

{"Version":1,"Timestamp":"2023-05-13T00:50:03.889192694Z",
"Data":"bm90IHVwZ3JhZGVk"}

func (*RemoteKV) DeleteRemoteKeyListener ¶ added in v0.3.4

func (r *RemoteKV) DeleteRemoteKeyListener(_ js.Value, args []js.Value) any

DeleteRemoteKeyListener deletes a specific listener for a key.

Parameters:

• args[0] - the key to delete for
• args[1] - the id of the listener

func (*RemoteKV) DeleteRemoteMapListener ¶ added in v0.3.4

func (r *RemoteKV) DeleteRemoteMapListener(_ js.Value, args []js.Value) any

DeleteRemoteMapListener deletes a specific listener for a key.

Parameters:

• args[0] - the mapName to delete for
• args[1] - the id of the listener

func (*RemoteKV) Get ¶ added in v0.3.4

func (r *RemoteKV) Get(_ js.Value, args []js.Value) any

Get returns the object stored at the specified version. returns a json of [versioned.Object].

Parameters:

• args[0] - key to access, a string
• args[1] - version, an integer

Returns a promise:

• Resolves to JSON of a [versioned.Object], e.g.: {"Version":1,"Timestamp":"2023-05-13T00:50:03.889192694Z","Data":"bm90IHVwZ3JhZGVk"}
• Rejected with an access error. Note: File does not exist errors are returned whent key is not set.

func (*RemoteKV) GetAllRemoteKeyListeners ¶ added in v0.3.4

func (r *RemoteKV) GetAllRemoteKeyListeners(_ js.Value, args []js.Value) any