collaboration module

binaryninja.collaboration.changeset.Changeset(handle)

Class representing a collection of snapshots in a local database

binaryninja.collaboration.file.RemoteFile(handle)

Class representing a remote project file.

binaryninja.collaboration.folder.RemoteFolder(handle)

Class representing a remote folder in a project.

binaryninja.collaboration.group.Group(handle)

Class representing a remote Group

binaryninja.collaboration.project.RemoteProject(handle)

Class representing a remote project

binaryninja.collaboration.remote.Remote(handle)

Class representing a connection to a Collaboration server

binaryninja.collaboration.snapshot.CollabSnapshot(handle)

Class representing a remote Snapshot

binaryninja.collaboration.snapshot.UndoEntry(handle)

Class representing a remote undo entry

binaryninja.collaboration.user.User(handle)

Class representing a remote User
active_remote() → Remote | None[source]

Get the single actively connected Remote (for ux simplification)

Returns:

Active Remote, if one is set. None, otherwise.

Return type:

Remote | None

create_remote(name: str, address: str) → Remote[source]

Create a Remote and add it to the list of known remotes (saved to Settings)

Parameters:

  • name (str) – Identifier for remote

  • address (str) – Base address (HTTPS) for all api requests

Return type:

Remote

enterprise_remote() → Remote | None[source]

Get whichever known Remote has the same address as the Enterprise license server

Returns:

Relevant known Remote, or None if one is not found

Return type:

Remote | None

get_remote_by_address(address: str) → Remote | None[source]

Get Remote by address

Parameters:

address (str) – Base address of remote api

Returns:

Remote, if found, else None

Return type:

Remote | None

get_remote_by_id(id: str) → Remote | None[source]

Get Remote by unique id

Parameters:

id (str) – Unique id of the Remote

Returns:

Remote, if known, else None

Return type:

Remote | None

get_remote_by_name(name: str) → Remote | None[source]

Get Remote by name

Parameters:

name (str) – Name of Remote

Returns:

Remote, if found, else None

Return type:

Remote | None

known_remotes() → List[Remote][source]

List of known/connected Remotes

Returns:

All known remotes

Return type:

List[Remote]

load_remotes()[source]

Load the list of known Remotes from local Settings

Raises:

RuntimeError – If there was an error

remove_known_remote(remote: Remote) → None[source]

Remove a Remote from the list of known remotes (saved to Settings)

Parameters:

remote (Remote) – Remote to remove

Return type:

None

save_remotes()[source]

Save the list of known Remotes to local Settings

Raises:

RuntimeError – If there was an error

set_active_remote(remote: Remote | None)[source]

Set the single actively connected Remote

Parameters:

remote (Remote | None) – New active Remote, or None to clear it.