# Usage

# Pinch

# Available consents

PinchConsent.SURVEYS
PinchConsent.ANALYTICS
PinchConsent.CAMPAIGNS
PinchConsent.ADS

# Granting consents

Accepts a list of consents.

Pinch.grant([PinchConsent.ANALYTICS, PinchConsent.SURVEYS]);

# Revoking consents

Accepts a list of consents.

Pinch.revoke([PinchConsent.ANALYTICS, PinchConsent.SURVEYS]);

# Retrieve granted consents

Returns a list of numbers. Can be compared against PinchConsent if necessary.

Pinch.getGrantedConsents().then(consents => console.log(consents));

# Request Permissions

Use default APIs to request permissions like notification, location and bluetooth where needed. For iOS make sure to request location when in use and always in separate steps to ensure the user get the dialogs within the app context.

// Bluetooth Permission is only needed from iOS 12+ and is granted by default prior to this
if (Platform.OS == "ios" && parseInt(Platform.Version, 10) > 12) {
    request(PERMISSIONS.IOS.BLUETOOTH_PERIPHERAL).then(result => {
        console.warn(result)
    })
} else {
    console.warn("Permissions not required.")
}

# Start SDK

Pinch.start();

# Stop SDK

Pinch.stop();

# Retrieve SDK status

Returns a boolean.

Pinch.isStarted().then(started => console.log(started));

# Send demographic profile

Used to send birth year and gender of user to the Pinch Network. Method accepts a year and gender.

Pinch.sendDemographicProfile(1995, PinchGender.MALE);

// available genders: PinchGender.MALE, PinchGender.FEMALE, PinchGender.UNKNOWN

::: ::::

# Send custom data

var type = "order";
var content = {"orderId": 12, "items": [1, 2, 3]};

Pinch.addCustomEvent(type, JSON.stringify(content));

# Send metadata

let type = "name";
let content = {"nickname": "jas"};
Pinch.setMetadata(type, JSON.stringify(content));

# Push tokens

MessagingId is the ID used by the Pinch Platform for sending notifications to the device (eg. FCM registration id). This can be done by calling:

Pinch.setMessagingId("<token>");

# Retrieve privacy terms URL

The URL for privacy terms can be retrieved by calling:

Pinch.getPrivacyTermsUrl().then(urlString => console.log(urlString));

# Retrieve privacy dashboard URL

The URL for the privacy dashboard, which contains all collected data for given consent, can be retrieved by calling:

Pinch.getPrivacyDashboard().then(urlString => console.log(urlString));

# Deleted collected PII & data

You can delete all PII and collected data about a user by calling this method.

Pinch.deleteCollectedData();

# Pinch Messaging Center

Retrieve incoming messages to user from Pinch.

Pinch.getMessages().then(messages => console.log(messages));