collaboration module¶

`binaryninja.collaboration.changeset.Changeset`([...])	Class representing a collection of snapshots in a local database
`binaryninja.collaboration.file.File`(handle)	Class representing a remote analysis database.
`binaryninja.collaboration.folder.Folder`(handle)	Class representing a remote folder in a project.
`binaryninja.collaboration.group.Group`(handle)	Class representing a remote Group
`binaryninja.collaboration.merge.ConflictFormatter`([...])	Helper class that turns json conflicts into pretty text for the ui to render
`binaryninja.collaboration.merge.ConflictHandler`([...])	Helper class that resolves conflicts
`binaryninja.collaboration.merge.ConflictSplitter`([...])	Helper class that takes one merge conflict and splits it into multiple conflicts Eg takes conflicts for View/symbols and splits to one conflict per symbol
`binaryninja.collaboration.merge.CoreConflictFormatter`([...])	FFI wrapper for conflict formatters
`binaryninja.collaboration.merge.CoreConflictSplitter`([...])	FFI wrapper for core-constructed splitters
`binaryninja.collaboration.merge.FormattedConflict`([...])	Class taking a merge conflict and producing a formatted text output.
`binaryninja.collaboration.merge.FormatterList`()	Mutable list of formatters for FFI purposes
`binaryninja.collaboration.merge.MergeConflict`(handle)	Structure representing an individual merge conflict
`binaryninja.collaboration.merge.SplitterList`()	Mutable list of splitters for FFI purposes
`binaryninja.collaboration.project.Project`(handle)	Class representing a remote project
`binaryninja.collaboration.remote.Remote`([...])	Class representing a connection to a Collaboration server
`binaryninja.collaboration.snapshot.Snapshot`(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

add_known_remote(remote: Remote) → None[source]¶

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

Parameters:: remote (Remote) – New Remote to add
Return type:: None

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.