# iOS Native SDK

## Các hàm trong iOS Native SDK

### `initWithClientKey`

Khởi tạo Pushdy SDK với Client Key. Bạn có thể sao chép Client Key tại Dashboard của Pushdy sau khi bạn tạo ứng dụng. Mỗi ứng dụng sẽ có 1 Client Key duy nhất.\
Hàm `initWithClientKey` được sử dụng trong hàm `didFinishLaunchingWithOptions` trong file `AppDelegate` của bạn.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
NSString *clientKey = @"YOUR_CLIENT_KEY";
[Pushdy initWithClientKey:clientKey delegate:self launchOptions:launchOptions];
```

{% endtab %}

{% tab title="Swift" %}

```swift
let clientKey = "YOUR_CLIENT_KEY"
Pushdy.initWith(clientKey: clientKey, delegate: self, launchOptions: launchOptions)
```

{% endtab %}
{% endtabs %}

### `setDeviceID`

Bạn có thể tuỳ chỉnh **Device ID** theo logic của bạn. Nếu bạn không sử dụng hàm này, **Device ID** sẽ được tự động sinh ra để đảm bảo định danh user là duy nhất.\
Hàm này phải được gọi ngay trước hàm `initWithClientKey` khi bạn khởi tạo Pushdy SDK để đảm bảo *Custom Device ID* được lưu lại trước khi Pusdy SDK gửi yêu cầu tới máy chủ.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec

NSString *customDeviceID = @"YOUR CUSTOM ID";
[Pushdy setDeviceID:customDeviceID];
```

{% endtab %}

{% tab title="Swift" %}

```swift
let customDeviceID = "YOUR CUSTOM ID"
Pushdy.setDeviceID(customDeviceID)
```

{% endtab %}
{% endtabs %}

### `getDeviceID`

Với hàm này bạn có thể truy xuất **Device ID** của bạn.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
NSString *yourDeviceID = [Pushdy getDeviceID]
```

{% endtab %}

{% tab title="Swift" %}

```swift
let yourDeviceID = Pushdy.getDeviceID()
```

{% endtab %}
{% endtabs %}

### `registerForPushNotification`

Sử dụng để hiển thị cửa sổ xin quyền Push Notification. Để tăng tỷ lệ user đồng ý nhận Push Notification, bạn nên gọi hàm này sau khi đã hiển thị đầy đủ thông tin về lợi ích của việc bật Push Notification với user.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
[Pushdy registerForPushNotifications];
```

{% endtab %}

{% tab title="Swift" %}

```swift
Pushdy.registerForPushNotifications()
```

{% endtab %}
{% endtabs %}

#### `checkNotificationEnabled`

Kiểm tra xem người dùng có bật Push Notification cho iOS App của bạn hay không.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
[Pushdy checkNotificationEnabled:^(BOOL enabled) {
    // ...
}];
```

{% endtab %}

{% tab title="Swift" %}

```swift
Pushdy.checkNotificationEnabled { (enabled:Bool) in
    // ...
}
```

{% endtab %}
{% endtabs %}

### `getDeviceToken`

Lấy APNs Token. Token này chỉ có khi người dùng bật Push Notification cho App.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
NSString *deviceToken = [Pushdy getDeviceToken];
```

{% endtab %}

{% tab title="Swift" %}

```swift
let deviceToken = Pushdy.getDeviceToken()
```

{% endtab %}
{% endtabs %}

### `getPendingNotification`

Lấy Notification mới nhất từ danh sách các Notification chưa được xử lý.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
NSDictionary *latestNotification = [Pushdy getPendingNotification];
```

{% endtab %}

{% tab title="Swift" %}

```swift
let latestNotification = Pushdy.getPendingNotification()
```

{% endtab %}
{% endtabs %}

### `getPendingNotifications`

Lấy danh sách toàn bộ Notification từ danh sách hàng đợi chưa được xử lý.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
NSArray *pendingNotifications = [Pushdy getPendingNotifications];
```

{% endtab %}

{% tab title="Swift" %}

```swift
let pendingNotifications = Pushdy.getPendingNotifications()
```

{% endtab %}
{% endtabs %}

### `setAttribute`

Tracking dữ liệu để gửi lên Pushdy nhằm phục vụ phân đoạn người dùng khi gửi Push. Với hàm này, dữ liệu mới sẽ đè lên dữ liệu cũ. Bạn có thể xem thêm chi tiết cách định nghĩa thuộc tính tại phần [Tạo thuộc tính](https://guide.pushdy.com/i/huong-dan-su-dung/tao-thuoc-tinh).

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
[Pushdy setAttribute:@"your_attribute_name" value:@"your_value" error:nil];
```

{% endtab %}

{% tab title="Swift" %}

```swift
try? Pushdy.setAttribute("your_attribute_name", value: "your_value") 
```

{% endtab %}
{% endtabs %}

### `pushAttribute`

Tương tự hàm `setAttribute` nhưng chỉ hoạt động với thuộc tính được định nghĩa là kiểu mảng (Array). Mảng giá trị mới sẽ được gắn thêm vào sau giá trị cũ.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
NSArray *your_values_array = @[@"new_value_1", @"new_value_2"];
[Pushdy pushAttribute:@"your_attribute_name" value:your_values_array error:nil];
```

{% endtab %}

{% tab title="Swift" %}

```swift
let your_values_array:[String] = [
    "new_value_1",
    "new_value_2"
]
try? Pushdy.pushAttribute("your_attribute_name", value: your_values_array)
```

{% endtab %}
{% endtabs %}

### `getPlayerId`

Lấy Player ID của người dùng, ID này do Pushdy sinh ra cho mỗi người dùng đầu cuối. Chú ý, mỗi 1 thiết bị sẽ có 1 Player ID duy nhất, trường hợp gỡ ứng dụng và cài lại thì Player ID vẫn giữ nguyên. Player ID chỉ thay đổi khi bạn thay đổi Device ID bằng hàm `setDeviceID`. 

{% tabs %}
{% tab title="Objective C" %}

```objectivec
NSString *playerID = [Pushdy getPlayerID];
```

{% endtab %}

{% tab title="Swift" %}

```swift
let playerID = Pushdy.getPlayerID()
```

{% endtab %}
{% endtabs %}

## Các Delegation trong iOS Native SDK

### `readyForHandlingNotification`

Nếu hàm trả về giá trị là **false** có nghĩa là Push Notification sẽ không được xử lý ngay tại thời điểm nhận được mà sẽ được đưa vào hàng đợi. Bạn chỉ có thể lấy và xử lý Push Notification này bằng cách sử dụng hàm `getPendingNotification` hoặc `getPendingNotifications` . Mặc định giá trị được trả về sẽ là **true,** có nghĩa là Push Notification sẽ được xử lý ngay khi Device của bạn nhận được.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
(BOOL)readyForHandlingNotification {
    BOOL already = YES;
    // your custom logic
    if (my_screen_name == "tutorial") {
        // không hiển thị push ở màn hình Tutorial mà sẽ chủ động hiển thị khi 
        // sau khi user hoàn thành tutorial
        already = NO;
    }
    return already;
}
```

{% endtab %}

{% tab title="Swift" %}

```swift
func readyForHandlingNotification() -> Bool {
    var already = true
    // your custom logic
    if (my_screen_name == "tutorial") {
        // không hiển thị push ở màn hình Tutorial mà sẽ chủ động hiển thị khi 
        // sau khi user hoàn thành tutorial
        already = false;
    }
    return already
}
```

{% endtab %}
{% endtabs %}

### `onNotificationReceived`

Được gọi khi app của bạn nhận được Push Notification. Chú ý, sự kiện này chỉ xảy ra khi App của bạn đang được mở.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
(void)onNotificationReceived:(NSDictionary<NSString *,id> *)notification 
                                fromState:(NSString *)fromState {
    NSLog(@"Received notification from state: %@", fromState);
}
```

{% endtab %}

{% tab title="Swift" %}

```swift
func onNotificationReceived(_ notification: [String : Any], fromState: String) {
   print("Received notification from state: \(fromState)")     
}
```

{% endtab %}
{% endtabs %}

### `onNotificationOpened`

Được gọi khi người dùng nhấp vào Push Notification.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
(void)onNotificationOpened:(NSDictionary<NSString *,id> *)notification 
                                fromState:(NSString *)fromState {
    NSLog(@"Opened notification from state: %@", fromState);
}
```

{% endtab %}

{% tab title="Swift" %}

```swift
func onNotificationOpened(_ notification: [String : Any], fromState: String) {
     print("Opened notification from state: \(fromState)")     
}
```

{% endtab %}
{% endtabs %}

## Một số hàm dùng để tuỳ biến hiển thị Push Notification

### `setPushBannerAutoDismiss`

Bật/tắt tự động ẩn cửa sổ cho Push Notification khi bạn đang mở App. Nếu bạn tắt điều khiển tự động, người dùng sẽ phải chủ động nhấp vào "x" button trên cửa sổ Push để tắt thông báo.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
[Pushdy setPushBannerAutoDismiss:TRUE];
```

{% endtab %}

{% tab title="Swift" %}

```swift
Pushdy.setPushBannerAutoDismiss(true)
```

{% endtab %}
{% endtabs %}

### `setPushBannerAutoDismissDuration`

Thiết lập thời gian hiển thị cửa sổ Push Notification khi bạn đang mở App. Mặc định, thời gian hiển thị là 5 giây. Hàm này chỉ hoạt động khi bạn bật chức năng tự động ẩn cửa sổ Push.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
[Pushdy setPushBannerDismissDuration:5];
```

{% endtab %}

{% tab title="Swift" %}

```swift
Pushdy.setPushBannerDismissDuration(5)
```

{% endtab %}
{% endtabs %}

### `setCustomPushBanner`

Tuỳ chỉnh cửa sổ hiển thị Push Notification.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
[Pushdy setCustomPushBanner:yourUIView];
```

{% endtab %}

{% tab title="Swift" %}

```swift
Pushdy.setCustomPushBanner(yourUIView)
```

{% endtab %}
{% endtabs %}

### `setCustomMediaKey`

Tuỳ chỉnh Json key cho media url để hiển thị ảnh trên cửa sổ Push Notification khi đang bật App. Mặc định, media\_url sẽ là key được sử dụng.

{% tabs %}
{% tab title="Objective-C" %}

```objectivec
[PDYNotificationView setCustomMediaKey:@"your_custom_media_key"];
```

{% endtab %}

{% tab title="Swift" %}

```swift
PDYNotificationView.setCustomMediaKey("your_custom_media_key")
```

{% endtab %}
{% endtabs %}