collaboration module

Class	Description
binaryninja.collaboration.changeset.Changeset	Class representing a collection of snapshots in a local database
binaryninja.collaboration.file.RemoteFile	Class representing a remote project file. It controls the various snapshots and raw file…
binaryninja.collaboration.folder.RemoteFolder	Class representing a remote folder in a project.
binaryninja.collaboration.group.Group	Class representing a remote Group
binaryninja.collaboration.project.RemoteProject	Class representing a remote project
binaryninja.collaboration.remote.Remote	Class representing a connection to a Collaboration server
binaryninja.collaboration.snapshot.CollabSnapshot	Class representing a remote Snapshot
binaryninja.collaboration.snapshot.UndoEntry	Class representing a remote undo entry
binaryninja.collaboration.user.User	Class representing a remote User
binaryninja.collaboration.active_remote	Get the single actively connected Remote (for ux simplification)
binaryninja.collaboration.create_remote	Create a Remote and add it to the list of known remotes (saved to Settings)
binaryninja.collaboration.enterprise_remote	Get whichever known Remote has the same address as the Enterprise license server
binaryninja.collaboration.get_remote_by_address	Get Remote by address
binaryninja.collaboration.get_remote_by_id	Get Remote by unique id
binaryninja.collaboration.get_remote_by_name	Get Remote by name
binaryninja.collaboration.known_remotes	List of known/connected Remotes
binaryninja.collaboration.load_remotes	Load the list of known Remotes from local Settings
binaryninja.collaboration.remove_known_remote	Remove a Remote from the list of known remotes (saved to Settings)
binaryninja.collaboration.save_remotes	Save the list of known Remotes to local Settings
binaryninja.collaboration.set_active_remote	Set the single actively connected Remote

active_remote

class active_remote

Bases:

Get the single actively connected Remote (for ux simplification)

Returns:

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

create_remote

class create_remote

Bases:

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

Parameters:

• name – Identifier for remote

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

enterprise_remote

class enterprise_remote

Bases:

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

Returns:

Relevant known Remote, or None if one is not found

get_remote_by_address

class get_remote_by_address

Bases:

Get Remote by address

Parameters:

address – Base address of remote api

Returns:

Remote, if found, else None

get_remote_by_id

class get_remote_by_id

Bases:

Get Remote by unique id

Parameters:

id – Unique id of the Remote

Returns:

Remote, if known, else None

get_remote_by_name

class get_remote_by_name

Bases:

Get Remote by name

Parameters:

name – Name of Remote

Returns:

Remote, if found, else None

known_remotes

class known_remotes

Bases:

List of known/connected Remotes

Returns:

All known remotes

load_remotes

class load_remotes

Bases:

Load the list of known Remotes from local Settings

Raises:

RuntimeError – If there was an error

remove_known_remote

class remove_known_remote

Bases:

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

Parameters:

remote – Remote to remove

save_remotes

class save_remotes

Bases:

Save the list of known Remotes to local Settings

Raises:

RuntimeError – If there was an error

set_active_remote

class set_active_remote

Bases:

Set the single actively connected Remote

Parameters:

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