Public Member Functions | |
| CollabSnapshot (BNCollaborationSnapshot *snapshot) | |
| Ref< RemoteFile > | GetFile () |
| Ref< RemoteProject > | GetProject () |
| Ref< Remote > | GetRemote () |
| std::string | GetUrl () |
| std::string | GetId () |
| std::string | GetName () |
| std::string | GetAuthor () |
| int64_t | GetCreated () |
| int64_t | GetLastModified () |
| std::string | GetHash () |
| std::string | GetSnapshotFileHash () |
| bool | HasPulledUndoEntries () |
| bool | IsFinalized () |
| std::vector< std::string > | GetParentIds () |
| std::vector< std::string > | GetChildIds () |
| uint64_t | GetAnalysisCacheBuildId () |
| std::string | GetTitle () |
| Get the title of a snapshot: the first line of its name. More... | |
| std::string | GetDescription () |
| Get the description of a snapshot: the lines of its name after the first line. More... | |
| std::string | GetAuthorUsername () |
| Get the username of the author of a snapshot, if possible (vs GetAuthor() which is user id) More... | |
| std::vector< Ref< CollabSnapshot > > | GetParents () |
| Get all snapshots in this snapshot's file that are parents of this snapshot. More... | |
| std::vector< Ref< CollabSnapshot > > | GetChildren () |
| Get all snapshots in this snapshot's file that are children of this snapshot. More... | |
| std::vector< Ref< CollabUndoEntry > > | GetUndoEntries () |
| Get all undo entries in the snapshot. More... | |
| Ref< CollabUndoEntry > | GetUndoEntryById (uint64_t id) |
| Get a undo entry in the snapshot by its id. More... | |
| void | PullUndoEntries (std::function< bool(size_t, size_t)> progress={}) |
| Pull list of undo entries from the remote. More... | |
| Ref< CollabUndoEntry > | CreateUndoEntry (std::optional< uint64_t > parent, std::string data) |
| Create a new undo entry on the remote (and pull it) More... | |
| void | Finalize () |
| Mark the snapshot as Finalized, preventing future modification and allowing child snapshots This change is pushed instantly (calls the finalize endpoint) More... | |
| std::vector< uint8_t > | DownloadSnapshotFile (std::function< bool(size_t, size_t)> progress={}) |
| Download the contents of the file backing a snapshot N.B. More... | |
| std::vector< uint8_t > | Download (std::function< bool(size_t, size_t)> progress={}) |
| Download the contents of the snapshot. More... | |
| std::vector< uint8_t > | DownloadAnalysisCache (std::function< bool(size_t, size_t)> progress={}) |
| Download the contents of the analysis cache for this snapshot, returns an empty vector if there is no cache (eg: old snapshots) More... | |
 Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNCollaborationSnapshot, BNNewCollaborationSnapshotReference, BNFreeCollaborationSnapshot > | |
| CoreRefCountObject () | |
| virtual | ~CoreRefCountObject () |
| BNCollaborationSnapshot * | GetObject () const |
| void | AddRef () |
| void | Release () |
| void | AddRefForRegistration () |
| void | ReleaseForRegistration () |
| void | AddRefForCallback () |
| void | ReleaseForCallback () |
Additional Inherited Members | |
| Static Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNCollaborationSnapshot, BNNewCollaborationSnapshotReference, BNFreeCollaborationSnapshot > | |
| static BNCollaborationSnapshot * | GetObject (CoreRefCountObject *obj) |
| static BNCollaborationSnapshot * | GetObject (const CoreRefCountObject *obj) |
| Public Attributes inherited from BinaryNinja::CoreRefCountObject< BNCollaborationSnapshot, BNNewCollaborationSnapshotReference, BNFreeCollaborationSnapshot > | |
| std::atomic< int > | m_refs |
| bool | m_registeredRef |
| BNCollaborationSnapshot * | m_object |
| CollabSnapshot::CollabSnapshot | ( | BNCollaborationSnapshot * | snapshot | ) |
| Ref< RemoteFile > CollabSnapshot::GetFile | ( | ) |
| Ref< RemoteProject > CollabSnapshot::GetProject | ( | ) |
| std::string CollabSnapshot::GetUrl | ( | ) |
| std::string CollabSnapshot::GetId | ( | ) |
| std::string CollabSnapshot::GetName | ( | ) |
| std::string CollabSnapshot::GetAuthor | ( | ) |
| int64_t CollabSnapshot::GetCreated | ( | ) |
| int64_t CollabSnapshot::GetLastModified | ( | ) |
| std::string CollabSnapshot::GetHash | ( | ) |
| std::string CollabSnapshot::GetSnapshotFileHash | ( | ) |
| bool CollabSnapshot::HasPulledUndoEntries | ( | ) |
| bool CollabSnapshot::IsFinalized | ( | ) |
| std::vector< std::string > CollabSnapshot::GetParentIds | ( | ) |
| std::vector< std::string > CollabSnapshot::GetChildIds | ( | ) |
| uint64_t CollabSnapshot::GetAnalysisCacheBuildId | ( | ) |
| std::string CollabSnapshot::GetTitle | ( | ) |
Get the title of a snapshot: the first line of its name.
| std::string CollabSnapshot::GetDescription | ( | ) |
Get the description of a snapshot: the lines of its name after the first line.
| std::string CollabSnapshot::GetAuthorUsername | ( | ) |
Get the username of the author of a snapshot, if possible (vs GetAuthor() which is user id)
| std::vector< Ref< CollabSnapshot > > CollabSnapshot::GetParents | ( | ) |
Get all snapshots in this snapshot's file that are parents of this snapshot.
| RemoteException | If a parent snapshot does not exist in the file or if the remote is not connected |
| std::vector< Ref< CollabSnapshot > > CollabSnapshot::GetChildren | ( | ) |
Get all snapshots in this snapshot's file that are children of this snapshot.
| RemoteException | If a child snapshot does not exist in the file or if the remote is not connected |
| std::vector< Ref< CollabUndoEntry > > CollabSnapshot::GetUndoEntries | ( | ) |
Get all undo entries in the snapshot.
| RemoteException | if undo entries have not been pulled or if the remote is not connected |
| Ref< CollabUndoEntry > CollabSnapshot::GetUndoEntryById | ( | uint64_t | id | ) |
Get a undo entry in the snapshot by its id.
| id | Undo entry's id |
| RemoteException | If undo entries have not been pulled or if the remote is not connected |
| void CollabSnapshot::PullUndoEntries | ( | std::function< bool(size_t, size_t)> | progress = {} | ) |
Pull list of undo entries from the remote.
Necessary before calling GetUndoEntries()
| progress | Function to call on progress updates |
| RemoteException | If there is an error in any request or if the remote is not connected |
| Ref< CollabUndoEntry > CollabSnapshot::CreateUndoEntry | ( | std::optional< uint64_t > | parent, |
| std::string | data | ||
| ) |
Create a new undo entry on the remote (and pull it)
| parent | Undo entry parent id (if exists) |
| data | Undo entry data |
| RemoteException | If there is an error in any request, or if the snapshot is finalized, or if the remote is not connected |
| void CollabSnapshot::Finalize | ( | ) |
Mark the snapshot as Finalized, preventing future modification and allowing child snapshots This change is pushed instantly (calls the finalize endpoint)
| RemoteException | if there is an error in any request or if the remote is not connected |
| std::vector< uint8_t > CollabSnapshot::DownloadSnapshotFile | ( | std::function< bool(size_t, size_t)> | progress = {} | ) |
Download the contents of the file backing a snapshot N.B.
Multiple snapshots can be backed by the same file
| progress | Function to call on progress updates |
| RemoteException | If there is an error in any request or if the remote is not connected |
| std::vector< uint8_t > CollabSnapshot::Download | ( | std::function< bool(size_t, size_t)> | progress = {} | ) |
Download the contents of the snapshot.
| progress | Function to call on progress updates |
| RemoteException | If there is an error in any request or if the remote is not connected |
| std::vector< uint8_t > CollabSnapshot::DownloadAnalysisCache | ( | std::function< bool(size_t, size_t)> | progress = {} | ) |
Download the contents of the analysis cache for this snapshot, returns an empty vector if there is no cache (eg: old snapshots)
| progress | Function to call on progress updates |
| RemoteException | If there is an error in any request or if the remote is not connected |
