configOptOut

This method is to configure the opt-out feature for the records. This feature lets you decide if the records created by your application on the local machine are uploaded to the EMOTIV cloud or not.

If the opt-out is on (ie the parameter newOptOut is true) then the records created on this machine will not be uploaded to the cloud. If the opt-out is off (ie the parameter newOptOut is false) then the records created on this machine will be uploaded to the cloud.

Please note that changing the opt-out configuration has no effect on the records previously created on the local computer. It only affects the records created after the change. Changing the opt-out configuration is not retroactive.

The opt-out configuration is linked to your application. Changing the configuration only affects the records created by your application. This has no effect on the records created by other applications.

The opt-out configuration is also linked to the EmotivID of the user. The opt-out can be turned on or off for each EmotivID. It is off by default.

You can check the field localOnly of a Record object to know if this record will stay on the local machine, or if it will be uploaded to the EMOTIV cloud.

Some licenses don't let you change the opt-out configuration and force the opt-out to be always on or always off. See the possible configurations below for details.

This method was added in Cortex 2.2.1

Parameters

Name	Type	Required	Description
cortexToken	string	yes	A token returned by authorize.
status	string	yes	Must be "get" or "set". Use "get" to read the current configuration of the opt-out feature. Use "set" to turn the opt-out on or off.
newOptOut	boolean	no	If the status is "set" then you must set this parameter to true or false, in order to turn the opt-out feature on or off. If the status is "get" then you should omit this parameter.

Result

The result is an object describing the current opt-out configuration. It includes these fields:

Name	Type	Description
optOutAvail	boolean	If false then the opt-out is always off. The value of this field depends on the current license. Some license force you to upload the records to the cloud.
forceOptOut	boolean	If true (and optOutAvail is also true) then the opt-out is always on. The value of this field depends on the current license. Some license don't let you upload the records to the cloud.
currOptOut	boolean	The current configuration of the opt-out. If this value is true, then the records created by your application won't be uploaded to the cloud. If this value is false, then they will.
message	string	A text message.

Possible Configurations

Here is an overview of the possible configurations:

optOutAvail	forceOptOut	currOptOut	Description
true	false	Variable, false by default	By default, currOptOut is false and the records created by your application will be uploaded to the cloud. You can change the opt-out configuration for each EmotivID.
true	true	Always true	The records will never be uploaded to the cloud. You cannot change the configuration.
false	false	Always false	The records will always be uploaded to the cloud. You cannot change the configuration.
false	true	Always false	The records will always be uploaded to the cloud. You cannot change the configuration.

Examples

Get the current configuration

Request

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "configOptOut",
    "params": {
        "cortexToken": "xxx",
        "status": "get"
    }
}

Response

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "currOptOut": false,
        "forceOptOut": false,
        "message": "Get opt-out configuration successfully",
        "optOutAvail": true
    }
}

Change the configuration

Request

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "configOptOut",
    "params": {
        "cortexToken": "xxx",
        "status": "set",
        "newOptOut": true
    }
}

Response

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "currOptOut": true,
        "forceOptOut": false,
        "message": "Update opt-out configuration successfully",
        "optOutAvail": true
    }
}