Cloud Mail 2020 Node.js Edition

Questions / Feedback?

IdentityAttributesType Property

Specifies the type of attribute.

Syntax

 amazonses.getIdentityAttributesType(index, [callback])

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getIdentityAttributesType([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setIdentityAttributesType([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Specifies the type of attribute. When calling GetIdentityAttributes either Notification or Verification attributes are retrieved. This property indicates which type the current attribute is. Possible values are:

AttributesTypeMeaning
0 Notification
1 Verification
2 None. This will be the case when ListIdentities is called. Only the IdentityName property will be populated.

Only some Attribute properties will be populated depending on the AttributesType. If the AttributesType is Notification (0) the following fields will be populated:

If the AttributesType is Verification (1) the following fields will be populated:

The size of the array is controlled by the IdentityCount property.

This property is read-only and not available at design time.

Data Type

Integer

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
Cloud Mail 2020 Node.js Edition - Version 20.0 [Build 7718]