Blocking SDK operations
A blocking version of the SDK.
These synchronous functions will block the current thread to execute instead of returning futures that need to be executed on a runtime. In every other way, they are identitical to their asynchronous counterparts.
This requires the optional
blocking feature to be enabled.
Struct that is used to make authenticated requests to the IronCore API. Instantiated with the details of an account's various ids, device, and signing keys. Once instantiated all operations will be performed in the context of the account provided. Identical to IronOxide but also contains a Runtime.
Device ID type. Validates that the provided ID is greater than 0
A failure to edit the access list of a document.
Result of granting or revoking access to a document. Both grant and revoke support partial success.
Result of decrypting a document. Includes minimal metadata as well as the decrypted bytes.
Result of successful unmanaged decryption
Result for encrypt operations.
Result for encrypt operations that do not store document access information with the webservice,
but rather return the access information as
Document ID. Unique within the segment. Must match the regex
Single document's (abbreviated) metadata. Returned as part of a
Metadata for each of the documents that the current user has access to decrypt.
Full metadata for a document.
(unencrypted) name of a document. Construct via
Failure to make the requested change to a group's membership or administrators.
Result from requesting changes to a group's membership or administrators. Partial success is supported.
Group ID. Unique within a segment. Must match the regex
List of (abbreviated) groups for which the requesting user is either an admin or member.
Abbreviated group information.
Group's user-assigned name. (non-unique)
Keypair for a newly created user
Metadata about a user device
Devices for a user, sorted by the device id
ID of a user. Unique with in a segment. Must match the regex
IDs and public key for existing user on verify result
Represents a Group struct which is returned from doc get to show the IDs and names of groups the document is visible to
Represents a User struct which is returned from doc get to show the IDs of users the document is visible to
Represents the reason a document can be viewed by the requesting user.
Either a user or a group. Allows for containing both.
Initialize the BlockingIronOxide SDK with a device. Verifies that the provided user/segment exists and the provided device keys are valid and exist for the provided account. If successful, returns instance of the BlockingIronOxide SDK.
Initialize the BlockingIronOxide SDK and check to see if the user that owns this