new EncryptedContent((optional))
An EncryptedContent holds an encryption type, a payload and other fields
representing encrypted content.
Parameters:
Name | Type | Description |
---|---|---|
(optional) |
EncryptedContent | If value is another EncryptedContent then copy it. If value is omitted then create an EncryptedContent with unspecified values. |
- Source:
Methods
getAlgorithmType() → {number}
Get the algorithm type from EncryptAlgorithmType.
- Source:
Returns:
The algorithm type from EncryptAlgorithmType, or null if
not specified.
- Type
- number
getInitialVector() → {Blob}
Get the initial vector.
- Source:
Returns:
The initial vector. If not specified, isNull() is true.
- Type
- Blob
getKeyLocator() → {KeyLocator}
Get the key locator.
- Source:
Returns:
The key locator. If not specified, getType() is null.
- Type
- KeyLocator
getPayload() → {Blob}
Get the payload.
- Source:
Returns:
The payload. If not specified, isNull() is true.
- Type
- Blob
setAlgorithmType(algorithmType) → {EncryptedContent}
Set the algorithm type.
Parameters:
Name | Type | Description |
---|---|---|
algorithmType |
number | The algorithm type from EncryptAlgorithmType. If not specified, set to null. |
- Source:
Returns:
This EncryptedContent so that you can chain calls
to update values.
- Type
- EncryptedContent
setInitialVector(initialVector) → {EncryptedContent}
Set the initial vector.
Parameters:
Name | Type | Description |
---|---|---|
initialVector |
Blob | The initial vector. If not specified, set to the default Blob() where isNull() is true. |
- Source:
Returns:
This EncryptedContent so that you can chain calls
to update values.
- Type
- EncryptedContent
setKeyLocator(keyLocator) → {EncryptedContent}
Set the key locator.
Parameters:
Name | Type | Description |
---|---|---|
keyLocator |
KeyLocator | The key locator. This makes a copy of the object. If not specified, set to the default KeyLocator(). |
- Source:
Returns:
This EncryptedContent so that you can chain calls
to update values.
- Type
- EncryptedContent
setPayload(payload) → {EncryptedContent}
Set the encrypted payload.
Parameters:
Name | Type | Description |
---|---|---|
payload |
Blob | The payload. If not specified, set to the default Blob() where isNull() is true. |
- Source:
Returns:
This EncryptedContent so that you can chain calls
to update values.
- Type
- EncryptedContent
wireDecode(input, wireFormat)
Decode the input using a particular wire format and update this
EncryptedContent.
Parameters:
Name | Type | Description |
---|---|---|
input |
Blob | Buffer | The buffer with the bytes to decode. |
wireFormat |
WireFormat | (optional) A WireFormat object used to decode this object. If omitted, use WireFormat.getDefaultWireFormat(). |
- Source:
wireEncode(wireFormat) → {Blob}
Encode this EncryptedContent for a particular wire format.
Parameters:
Name | Type | Description |
---|---|---|
wireFormat |
WireFormat | (optional) A WireFormat object used to encode this object. If omitted, use WireFormat.getDefaultWireFormat(). |
- Source:
Returns:
The encoded buffer in a Blob object.
- Type
- Blob