sdk-flutter-plugin

KO | EN

gitlite — search

#javascript #golang #android #machine-learning #deep-learning #linux #docker #macos #windows #cli #vue #security #pytorch #ios

sdk-flutter-plugin

(★ 13)

The Official Flutter Plugin for the Marketing Cloud MobilePush SDK.

sdk-flutter-plugin 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Salesforce Marketing Cloud Flutter Plugin

This module enables the integration of the Marketing Cloud Engagement MobilePush SDK into your Flutter applications.

## Release Notes

For release notes, please refer to [CHANGELOG.md](./CHANGELOG.md).

## Requirements

### Flutter

- Flutter version `3.3.0+`

### iOS

- minimum deployment target `iOS 12+`

### Android

- minSdkVersion `23+`
- compileSdkVersion `35+`

## Installation

To add the plugin to your application via [pub](https://pub.dev/packages/sfmc), run the following command:

```shell
flutter pub add sfmc
```

## Example Implementation

An example implementation is provided within the plugin. For setup details, see the [example app](/example).

### Android Setup

Please follow detailed [step by step guide](./Android.md) to setup Android Platform.

### iOS Setup

Please follow detailed step by step guide for [Swift](./iOS_swift.md) or [Objective-C](./iOS_objc.md) to setup iOS Platform.

## URL Handling

To handle URLs from push notifications, please follow iOS step by step guide for [Swift](./iOS_swift.md) or [Objective-C](./iOS_objc.md) and [Android step by step guide](./Android.md).

Please also see additional documentation on URL Handling for [Android](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/sdk-implementation/url-handling.html) and [iOS](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/sdk-implementation/implementation-urlhandling.html).

## Using APIs

In your app `import` the package and utilize the `SFMCSdk` APIs.

```
// Import the SFMC package into your application
import 'package:sfmc/sfmc.dart';

// Utilize the APIs
SFMCSdk.getSystemToken();
```

Please find the [API Refrences](#refrence) below.

## API Reference <a name="reference"></a>

**Kind**: global class

- [SFMCSdk](#SFMCSdk)<a name="SFMCSdk"></a>
  - [.isPushEnabled()](#SFMCSdk.isPushEnabled) ⇒ <code>Future&lt;bool?&gt;</code>
  - [.enablePush()](#SFMCSdk.enablePush) ⇒ <code>Future&lt;void&gt;</code>
  - [.disablePush()](#SFMCSdk.disablePush) ⇒ <code>Future&lt;void&gt;</code>
  - [.getSystemToken()](#SFMCSdk.getSystemToken) ⇒ <code>Future&lt;String?&gt;</code>
  - [.getAttributes()](#SFMCSdk.getAttributes) ⇒ <code>Future&lt;Map<Object?, Object?>?&gt;</code>
  - [.setAttribute(key, value)](#SFMCSdk.setAttribute) ⇒ <code>Future&lt;void&gt;</code>
  - [.clearAttribute(key)](#SFMCSdk.clearAttribute) ⇒ <code>Future&lt;void&gt;</code>
  - [.addTag(tag)](#SFMCSdk.addTag) ⇒ <code>Future&lt;void&gt;</code>
  - [.removeTag(tag)](#SFMCSdk.removeTag) ⇒ <code>Future&lt;void&gt;</code>
  - [.getTags()](#SFMCSdk.getTags) ⇒ <code>Future&lt;List<String&gt;&gt;</code>
  - [.setContactKey(contactKey)](#SFMCSdk.setContactKey) ⇒ <code>Future&lt;void&gt;</code>
  - [.getContactKey()](#SFMCSdk.getContactKey) ⇒ <code>Future&lt;String?&gt;</code>
  - [.enableLogging()](#SFMCSdk.enableLogging) ⇒ <code>Future&lt;void&gt;</code>
  - [.disableLogging()](#SFMCSdk.disableLogging) ⇒ <code>Future&lt;void&gt;</code>
  - [.logSdkState()](#SFMCSdk.logSdkState) ⇒ <code>Future&lt;void&gt;</code>
  - [.trackEvent(event)](#SFMCSdk.trackEvent) ⇒ <code>Future&lt;void&gt;</code>
  - [.getDeviceId()](#SFMCSdk.getDeviceId) ⇒ <code>Future&lt;String?&gt;</code>
  - [.setAnalyticsEnabled(analyticsEnabled)](#SFMCSdk.setAnalyticsEnabled) ⇒ <code>Future&lt;void&gt;</code>
  - [.isAnalyticsEnabled()](#SFMCSdk.isAnalyticsEnabled) ⇒ <code>Future&lt;bool&gt;</code>
  - [.setPiAnalyticsEnabled(analyticsEnabled)](#SFMCSdk.setPiAnalyticsEnabled) ⇒ <code>Future&lt;void&gt;</code>
  - [.isPiAnalyticsEnabled()](#SFMCSdk.isPiAnalyticsEnabled) ⇒ <code>Future&lt;bool&gt;</code>
  - [.getMessages()](#SFMCSdk.getMessages) ⇒ <code>Future&lt;List<InboxMessage&gt;&gt;</code>
  - [.getReadMessages()](#SFMCSdk.getReadMessages) ⇒ <code>Future&lt;List<InboxMessage&gt;&gt;</code>
  - [.getUnreadMessages()](#SFMCSdk.getUnreadMessages) ⇒ <code>Future&lt;List<InboxMessage&gt;&gt;;</code>
  - [.getDeletedMessages()](#SFMCSdk.getDeletedMessages) ⇒ <code>Future&lt;List<InboxMessage&gt;&gt;;</code>
  - [.getMessageCount()](#SFMCSdk.getMessageCount) ⇒ <code>Future&lt;int?&gt;</code>
  - [.getReadMessageCount()](#SFMCSdk.getReadMessageCount) ⇒ <code>Future&lt;int?&gt;</code>
  - [.getUnreadMessageCount()](#SFMCSdk.getUnreadMessageCount) ⇒ <code>Future&lt;int?&gt;</code>
  - [.getDeletedMessageCount()](#SFMCSdk.getDeletedMessageCount) ⇒ <code>Future&lt;int?&gt;</code>
  - [.setMessageRead.(messageId)](#SFMCSdk.setMessageRead) ⇒ <code>Future&lt;void&gt;</code>
  - [.deleteMessage.(messageId)](#SFMCSdk.deleteMessage) ⇒ <code>Future&lt;void&gt;</code>
  - [.markAllMessagesRead.(messageId)](#SFMCSdk.markAllMessagesRead) ⇒ <code>Future&lt;void&gt;</code>
  - [.markAllMessagesDeleted.(messageId)](#SFMCSdk.markAllMessagesDeleted) ⇒ <code>Future&lt;void&gt;</code>
  - [.refreshInbox()](#SFMCSdk.refreshInbox)  ⇒ <code>Future&lt;bool&gt;</code>
  - [.registerInboxResponseListener(InboxRefreshListener callback)](#SFMCSdk.registerInboxResponseListener)  ⇒ <code>void</code>
  - [.unregisterInboxResponseListener(InboxRefreshListener callback)](#SFMCSdk.unregisterInboxResponseListener)  ⇒ <code>void</code>

### SFMCSdk.isPushEnabled() ⇒ <code>Future&lt;bool?&gt;</code>

The current state of the pushEnabled flag in the native Marketing Cloud
SDK.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**Returns**: <code>Future&lt;bool?&gt;</code> - A future to the nullable boolean representation of whether push is
enabled.  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.push/-push-message-manager/is-push-enabled.html)
- [iOS Docs](<https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.0/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)pushEnabled>)

### SFMCSdk.enablePush() ⇒ <code>Future&lt;void&gt;</code>

Enables push messaging in the native Marketing Cloud SDK.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.push/-push-message-manager/enable-push.html)
- [iOS Docs](<https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.0/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)setPushEnabled:>)

### SFMCSdk.disablePush() ⇒ <code>Future&lt;void&gt;</code>

Disables push messaging in the native Marketing Cloud SDK.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.push/-push-message-manager/disable-push.html)
- [iOS Docs](<https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.0/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)setPushEnabled:>)

### SFMCSdk.getSystemToken() ⇒ <code>Future&lt;String?&gt;</code>

Returns the token used by the Marketing Cloud to send push messages to
the device.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**Returns**: <code>Future&lt;String?&gt;</code> - A future to the nullable system token string.  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.registration/-registration-manager/get-system-token.html)
- [iOS Docs](<https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.0/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)deviceToken>)

### SFMCSdk.getAttributes() ⇒ <code>Future&lt;Map&lt;String, String&gt;&gt;</code>

Returns the maps of attributes set in the registration.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**Returns**: <code>Future&lt;Map&lt;String, String&gt;&gt;</code> - A future to the string key/value map of attributes set
in the registration.  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.registration/-registration-manager/get-attributes.html)
- [iOS Docs](<https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.0/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)attributes>)

### SFMCSdk.setAttribute(key, value) ⇒ <code>Future&lt;void&gt;</code>

Sets the value of an attribute in the registration.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/SFMCSdk/8.0/-s-f-m-c%20-s-d-k/com.salesforce.marketingcloud.sfmcsdk.components.identity/-identity/set-profile-attribute.html)
- [iOS Docs](<https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/SFMCSdk/8.0/Classes/IDENTITY.html#/c:@M@SFMCSDK@objc(cs)SFMCSdkIDENTITY(im)setProfileAttributes:>)

| Param | Type                | Description                                                     |
| ----- | ------------------- | --------------------------------------------------------------- |
| key   | <code>string</code> | The name of the attribute to be set in the registration.        |
| value | <code>string</code> | The value of the `key` attribute to be set in the registration. |

### SFMCSdk.clearAttribute(key) ⇒ <code>Future&lt;void&gt;</code>

Clears the value of an attribute in the registration.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.registration/-registration-manager/-editor/clear-attribute.html)
- [iOS Docs](<https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/SFMCSdk/8.0/Classes/IDENTITY.html#/c:@M@SFMCSDK@objc(cs)SFMCSdkIDENTITY(im)clearProfileAttributeWithKey:>)

| Param | Type                | Description                                                                    |
| ----- | ------------------- | ------------------------------------------------------------------------------ |
| key   | <code>string</code> | The name of the attribute whose value should be cleared from the registration. |

### SFMCSdk.addTag(tag) ⇒ <code>Future&lt;void&gt;</code>

Adds a tag to the list of tags in the registration.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.registration/-registration-manager/-editor/add-tag.html)
- [iOS Docs](<https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.0/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)addTag:>)

| Param | Type                | Description                              |
| ----- | ------------------- | ---------------------------------------- |
| tag   | <code>string</code> | The tag to be added to the registration. |

### SFMCSdk.removeTag(tag) ⇒ <code>Future&lt;void&gt;</code>

Removes a tag from the list of tags in the registration.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.registration/-registration-manager/-editor/remove-tag.html)
- [iOS Docs](<https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.0/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)removeTag:>)

| Param | Type                | Description                                  |
| ----- | ------------------- | -------------------------------------------- |
| tag   | <code>string</code> | The tag to be removed from the registration. |

### SFMCSdk.getTags() ⇒ <code>Future&lt;List&lt;String&gt;&gt;</code>

Returns the list of tags currently set in the registration.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**Returns**: <code>Future&lt;List&lt;String&gt;&gt;</code> - A future to the list of strings representing the tags
currently set in the registration.  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.registration/-registration-manager/get-tags.html)
- [iOS Docs](<https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.0/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)tags>)

### SFMCSdk.setContactKey(contactKey) ⇒ <code>Future&lt;void&gt;</code>

Sets the contact key for the device's user.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/SFMCSdk/8.0/-s-f-m-c%20-s-d-k/com.salesforce.marketingcloud.sfmcsdk.components.identity/-identity/set-profile-id.html)
- [iOS Docs](<https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/SFMCSdk/8.0/Classes/IDENTITY.html#/c:@M@SFMCSDK@objc(cs)SFMCSdkIDENTITY(im)setProfileId:>)

| Param      | Type                | Description                                      |
| ---------- | ------------------- | ------------------------------------------------ |
| contactKey | <code>string</code> | The contact key to be set for the device's user. |

### SFMCSdk.getContactKey() ⇒ <code>Future&lt;String?&gt;</code>

Returns the contact key associated with the device's user.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**Returns**: <code>Future&lt;String?&gt;</code> - A future to the nullable string representation of the contact key
associated with the device's user.  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.registration/-registration-manager/get-contact-key.html)
- [iOS Docs](<https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.0/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)contactKey>)

### SFMCSdk.enableLogging() ⇒ <code>Future&lt;void&gt;</code>

Enables verbose logging within the native Marketing Cloud SDK and Unified SFMC SDK.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Android Docs](https://developer.salesforce.com/docs/marketing/mobilepush/guide/troubleshooting-android.html#check-the-sdks-log-output)
- [iOS Docs](<https://developer.salesforce.com/docs/marketing/mobilepush/guide/troubleshooting-ios.html#check-the-sdks-log-output>)

### SFMCSdk.disableLogging() ⇒ <code>Future&lt;void&gt;</code>

Disables verbose logging within the native Marketing Cloud SDK.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

### SFMCSdk.logSdkState() ⇒ <code>Future&lt;void&gt;</code>

Instructs the native SDK to log the SDK state to the native logging system (Logcat for
Android and Xcode/Console.app for iOS). This content can help diagnose most issues within
the SDK and will be requested by the Marketing Cloud support team.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/SFMCSdk/8.0/-s-f-m-c%20-s-d-k/com.salesforce.marketingcloud.sfmcsdk/-s-f-m-c-sdk/get-sdk-state.html)
- [iOS Docs](<https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/SFMCSdk/8.0/Classes/SFMCSdk.html#/c:@M@SFMCSDK@objc(cs)SFMCSdk(cm)state>)

### SFMCSdk.trackEvent(event) ⇒ <code>Future&lt;void&gt;</code>

This method helps to track events, which could result in actions such as an InApp Message being displayed.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Docs](https://developer.salesforce.com/docs/marketing/mobilepush/guide/event-tracking.html)

| Param | Type                                                                                                                                                                         | Description              |
|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| event | <code>CustomEvent</code> \| <code>EngagementEvent</code> \| <code>SystemEvent</code> \| <code>CartEvent</code> \| <code>OrderEvent</code> \| <code>CatalogObjectEvent</code> | The event to be tracked. |

### SFMCSdk.getDeviceId() ⇒ <code>Future&lt;String?&gt;</code>

Returns the deviceId used by the Marketing Cloud to send push messages to the device.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**Returns**: <code>Future&lt;String?&gt;</code> - A future to the device Id.  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.registration/-registration-manager/get-device-id.html)
- [iOS Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.0/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)deviceIdentifier)

### SFMCSdk.setAnalyticsEnabled(analyticsEnabled) ⇒ <code>Future&lt;void&gt;</code>

Enables or disables analytics in the Marketing Cloud SDK.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Docs](https://developer.salesforce.com/docs/marketing/mobilepush/guide/runtime-toggles.html)

| Param            | Type                 | Description                                            |
|------------------|----------------------|--------------------------------------------------------|
| analyticsEnabled | <code>boolean</code> | A flag indicating whether analytics should be enabled. |

### SFMCSdk.isAnalyticsEnabled() ⇒ <code>Future&lt;bool&gt;</code>

Checks if analytics is enabled in the Marketing Cloud SDK.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**Returns**: <code>Future&lt;bool&gt;</code> - A future to the boolean representation of whether analytics is enabled.  
**See**

- [Docs](https://developer.salesforce.com/docs/marketing/mobilepush/guide/runtime-toggles.html)

### SFMCSdk.setPiAnalyticsEnabled(analyticsEnabled) ⇒ <code>Future&lt;void&gt;</code>

Enables or disables Predictive Intelligence analytics in the Marketing Cloud SDK.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Docs](https://developer.salesforce.com/docs/marketing/mobilepush/guide/runtime-toggles.html)

| Param            | Type                 | Description                                               |
|------------------|----------------------|-----------------------------------------------------------|
| analyticsEnabled | <code>boolean</code> | A flag indicating whether PI analytics should be enabled. |

### SFMCSdk.isPiAnalyticsEnabled() ⇒ <code>Future&lt;bool&gt;</code>

Checks if Predictive Intelligence analytics is enabled in the Marketing Cloud SDK.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**Returns**: <code>Future&lt;bool&gt;</code> - A future to the boolean representation of whether PI analytics is enabled.  
**See**

- [Docs](https://developer.salesforce.com/docs/marketing/mobilepush/guide/runtime-toggles.html)

### SFMCSdk.getMessages() ⇒ <code>Future&lt;List&lt;InboxMessage&gt;&gt;</code>

Returns the list of Active, Read & Unread, not Deleted Inbox Messages.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**Returns**: <code>Future&lt;List&lt;InboxMessage&gt;&gt;</code> - A future to the InboxMessage list representing Active, Read & Unread, not Deleted Inbox Messages.
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.inbox/-inbox-message-manager/get-messages.html)
- [iOS Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.1/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)getAllMessages)

### SFMCSdk.getReadMessages() ⇒ <code>Future&lt;List&lt;InboxMessage&gt;&gt;</code>

Returns the list of Active, Read, not Deleted Inbox Messages

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.inbox/-inbox-message-manager/get-read-messages.html)
- [iOS Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.1/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)getReadMessages)

### SFMCSdk.getUnreadMessages() ⇒ <code>Future&lt;List&lt;InboxMessage&gt;&gt;</code>

Returns the list of Active, Unread, not Deleted Inbox Messages

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.inbox/-inbox-message-manager/get-unread-messages.html)
- [iOS Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.1/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)getUnreadMessages)

### SFMCSdk.getDeletedMessages() ⇒ <code>Future&lt;List&lt;InboxMessage&gt;&gt;</code>

Returns the list of Active, Deleted Inbox Messages

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.inbox/-inbox-message-manager/get-deleted-messages.html)
- [iOS Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.1/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)getDeletedMessages)

### SFMCSdk.getMessageCount() ⇒ <code>Future&lt;int?&gt;&gt;</code>

Returns the total number of not deleted Inbox Messages

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**Returns**: <code>Future&lt;int?&gt;&gt;</code> - A future to the int representing total number of not deleted Inbox Messages.
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.inbox/-inbox-message-manager/get-message-count.html)
- [iOS Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.1/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)getAllMessagesCount)

### SFMCSdk.getReadMessageCount() ⇒ <code>Future&lt;int?&gt;&gt;</code>

Returns the total number of read, not deleted Inbox Messages

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**Returns**: <code>Future&lt;int?&gt;&gt;</code> - A future to the int representing total number of read, not deleted Inbox Messages.
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.inbox/-inbox-message-manager/get-read-message-count.html)
- [iOS Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.1/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)getReadMessagesCount)

### SFMCSdk.getUnreadMessageCount() ⇒ <code>Future&lt;int?&gt;&gt;</code>

Returns the total number of unread, not deleted Inbox Messages

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**Returns**: <code>Future&lt;int?&gt;&gt;</code> - A future to the int representing total number of unread, not deleted Inbox Messages.
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.inbox/-inbox-message-manager/get-unread-message-count.html)
- [iOS Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.1/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)getUnreadMessagesCount)

### SFMCSdk.getDeletedMessageCount() ⇒ <code>Future&lt;int?&gt;&gt;</code>

Returns the total number of deleted Inbox Messages regardless of their read status.

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.inbox/-inbox-message-manager/get-deleted-message-count.html)
- [iOS Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.1/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)getDeletedMessagesCount)

### SFMCSdk.setMessageRead(messageId) ⇒ <code>Future&lt;void&gt;</code>

Marks a InboxMessage as read in local storage.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.inbox/-inbox-message-manager/set-message-read.html)
- [iOS Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.1/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)markMessageWithIdReadWithMessageId:)

| Param | Type                | Description                                                |
|-------|---------------------|------------------------------------------------------------|
| id    | <code>String</code> | The InboxMessage#id() of the InboxMessage to mark as read. |

### SFMCSdk.deleteMessage(messageId) ⇒ <code>Future&lt;void&gt;</code>

Marks a InboxMessage as deleted in local storage.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.inbox/-inbox-message-manager/delete-message.html)
- [iOS Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.1/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)markMessageWithIdDeletedWithMessageId:)

| Param | Type                | Description                                                   |
|-------|---------------------|---------------------------------------------------------------|
| id    | <code>String</code> | The InboxMessage#id() of the InboxMessage to mark as deleted. |

### SFMCSdk.markAllMessagesRead() ⇒ <code>Future&lt;void&gt;&gt;</code>

Marks all active, unread InboxMessages as read.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**Returns**: <code>Future&lt;void&gt;&gt;</code> - A future to the void that marks all active, unread InboxMessages as read.
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.inbox/-inbox-message-manager/mark-all-messages-read.html)
- [iOS Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.1/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)markAllMessagesRead)

### SFMCSdk.markAllMessagesDeleted() ⇒ <code>Future&lt;void&gt;&gt;</code>

Marks all active InboxMessages as deleted.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**Returns**: <code>Future&lt;void&gt;&gt;</code> - A future to the void that marks all active InboxMessages as deleted.
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.inbox/-inbox-message-manager/mark-all-messages-deleted.html)
- [iOS Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.1/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)markAllMessagesDeleted)

### SFMCSdk.refreshInbox() ⇒ <code>Future&lt;bool&gt;&gt;</code>

Requests an updated list of Inbox Messages from the Marketing Cloud Servers. The Inbox request can be made, at most, once per minute. This throttle also includes the Inbox request that is made by the SDK when your application is brought into the foreground.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**Returns**: <code>Future&lt;bool&gt;&gt;</code> - A future to the boolean representation if inbox has been refreshed or not.
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.inbox/-inbox-message-manager/refresh-inbox.html)
- [iOS Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-iOS/appledocs/MarketingCloudSdk/8.1/Classes/PushModule.html#/c:@M@MarketingCloudSDK@objc(cs)SFMCSdkPushModule(im)refreshMessages)

### SFMCSdk.registerInboxResponseListener(callback) ⇒ <code>void</code>

Call this method to be notified of Inbox events within the Marketing Cloud SDK.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.inbox/-inbox-message-manager/register-inbox-response-listener.html)
- [iOS Docs](https://developer.salesforce.com/docs/marketing/mobilepush/guide/implement-inbox-messaging-ios.html)

| Param    | Type                               | Description                                             |
|----------|------------------------------------|---------------------------------------------------------|
| callback | <code>InboxResponseListener</code> | The InboxResponseListener that you want to register.    |

### SFMCSdk.unregisterInboxResponseListener(callback) ⇒ <code>void</code>

Unregister your InboxMessageManager.InboxResponseListener listener.

**Kind**: static method of [<code>SFMCSdk</code>](#SFMCSdk)  
**See**

- [Android Docs](https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/javadocs/MarketingCloudSdk/8.0/-marketing%20-cloud%20-s-d-k/com.salesforce.marketingcloud.messages.inbox/-inbox-message-manager/unregister-inbox-response-listener.html)
- [iOS Docs](https://developer.salesforce.com/docs/marketing/mobilepush/guide/implement-inbox-messaging-ios.html)

| Param    | Type                               | Description                                            |
|----------|------------------------------------|--------------------------------------------------------|
| callback | <code>InboxResponseListener</code> | The InboxResponseListener that you want to unregister. |

### InboxResponseListener

The InboxResponseListener is a type definition for a callback function that handles a list of InboxMessage objects. It is used to respond to events or actions that return a list of inbox messages.

**Kind**: typedef

| Param      | Type                            | Description                     |
|------------|---------------------------------|---------------------------------|
| messages   | <code>List<InboxMessage></code> | A list of InboxMessage objects. |

### InboxRefreshListener

The InboxRefreshListener is a type definition for a callback function that handles the result of an inbox refresh operation. It indicates whether the refresh operation was successful or not.

**Kind**: typedef

| Param      | Type               | Description                                                                                                            |
|------------|--------------------|------------------------------------------------------------------------------------------------------------------------|
| successful | <code>bool</code>  | A boolean value, indicating the success of the refresh operation. true if the refresh was successful, false otherwise. |

### parseMessages

The parseMessages function takes a list of JSON strings, each representing an inbox message, and converts it into a list of InboxMessage objects.

***Returns***: <code>List<InboxMessage></code> - A list of InboxMessage objects.

| Param      | Type                      | Description                                                                                                       |
|------------|---------------------------|-------------------------------------------------------------------------------------------------------------------|
| messages   | <code>List<String></code> | A list of JSON strings (List<String>), where each string represents the data of an inbox message in JSON format.  |

### 3rd Party Product Language Disclaimers

Where possible, we changed noninclusive terms to align with our company value of Equality. We retained noninclusive terms to document a third-party system, but we encourage the developer community to embrace more inclusive language. We can update the term when it’s no longer required for technical accuracy.

sdk-flutter-plugin

sdk-flutter-plugin 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

sdk-flutter-plugin

sdk-flutter-plugin 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README