SDK APIガイド

              
               + (void)addTags:(NSSet<NSString *> *)tags
  completion:(MTPushTagsOperationCompletion)completion
         seq:(NSInteger)seq;

            

              
               * リクエスト時に渡されたシーケンス番号は、コールバック時にそのまま返されます

            

              
               + (void)setTags:(NSSet<NSString *> *)tags
  completion:(MTPushTagsOperationCompletion)completion
         seq:(NSInteger)seq;

            

              
               * リクエスト時に渡されたシーケンス番号は、コールバック時にそのまま返されます

            

              
               + (void)deleteTags:(NSSet<NSString *> *)tags
  completion:(MTPushTagsOperationCompletion)completion
         seq:(NSInteger)seq;

            

              
               * リクエスト時に渡されたシーケンス番号は、コールバック時にそのまま返されます

            

              
               + (void)cleanTags:(MTPushTagsOperationCompletion)completion
         seq:(NSInteger)seq;

            

              
               * リクエスト時に渡されたシーケンス番号は、コールバック時にそのまま返されます

            

              
               + (void)getAllTags:(MTPushTagsOperationCompletion)completion
         seq:(NSInteger)seq;

            

              
               * リクエスト時に渡されたシーケンス番号は、コールバック時にそのまま返されます

            

              
               + (void)validTag:(NSString *)tag
  completion:(MTPushTagValidOperationCompletion)completion
         seq:(NSInteger)seq;

            

              
               * リクエスト時に渡されたシーケンス番号は、コールバック時にそのまま返されます

            

              
               + (void)setAlias:(NSString *)alias
   completion:(MTPushAliasOperationCompletion)completion
          seq:(NSInteger)seq;

            

              
               * リクエスト時に渡されたシーケンス番号は、コールバック時にそのまま返されます

            

              
               + (void)deleteAlias:(MTPushAliasOperationCompletion)completion
             seq:(NSInteger)seq;

            

              
               * リクエスト時に渡されたシーケンス番号は、コールバック時にそのまま返されます

            

              
               + (void)getAlias:(MTPushAliasOperationCompletion)completion
          seq:(NSInteger)seq;

            

              
               * リクエスト時に渡されたシーケンス番号は、コールバック時にそのまま返されます

            

              
              + (void)pageEnterTo:(NSString *)pageName
+ (void)pageLeave:(NSString *)pageName;

            

              
              // 例えば、ViewControllerのviewDidAppear:とviewDidDisappear:メソッドでこれらのメソッドを使用できます
- (void)viewDidAppear:(BOOL)animated {
  [super viewDidAppear:animated];
  [MTPushService pageEnterTo:@"AViewController"];
}

- (void)viewDidDisappear:(BOOL)animated {
  [super viewDidDisappear:animated];
  [MTPushService pageLeave:@"AViewController"];
}

            

              
              - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions; 
// apnコンテンツの取得：
NSDictionary *remoteNotification = [launchOptions objectForKey: UIApplicationLaunchOptionsRemoteNotificationKey]

            

              
              - (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo;

            

              
              - (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler;

            

              
              - (void)mtpushNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(NSInteger))completionHandler; 
// NSDictionary * userInfo = notification.request.content.userInfo; 
// APNsコンテンツはuserInfoです

- (void)mtpNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)())completionHandler; 
// NSDictionary * userInfo = response.notification.request.content.userInfo; 
// APNsコンテンツはuserInfoです

            

              
              - (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo {
  // APNs標準情報コンテンツを取得
  NSDictionary *aps = [userInfo valueForKey:@"aps"];
  NSString *content = [aps valueForKey:@"alert"]; //プッシュ表示内容
  NSInteger badge = [[aps valueForKey:@"badge"] integerValue]; //バッジ番号
  NSString *sound = [aps valueForKey:@"sound"]; //再生される音
         
  // Extrasフィールドコンテンツを取得
  NSString *customizeField1 = [userInfo valueForKey:@"customizeExtras"]; //サーバー上のExtrasフィールド、キーは独自に定義
  NSLog(@"content =[%@], badge=[%d], sound=[%@], customize field  =[%@]",content,badge,sound,customizeField1);
         
  // iOS 10 以下 必須
  [MTPushService handleRemoteNotification:userInfo];
}

//iOS 7 Remote Notification
- (void)application:(UIApplication *)application didReceiveRemoteNotification:  (NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
     
  NSLog(@"this is iOS7 Remote Notification");
         
  // iOS 10 - 必須
  [MTPushService handleRemoteNotification:userInfo];
  completionHandler(UIBackgroundFetchResultNewData);
}

#pragma mark- MTPushRegisterDelegate // MTPushRegisterDelegateは2.1.9で追加されました。以下の2つのメソッドを実装する必要があります

// iOS 10 サポート
- (void)mtpNotificationCenter:(UNUserNotificationCenter *)center  willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(NSInteger))completionHandler {
  // 必須
  NSDictionary * userInfo = notification.request.content.userInfo;
  if([notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) {
    [MTPushService handleRemoteNotification:userInfo];
  }
  else {
     // ローカル通知
  }
  completionHandler(UNNotificationPresentationOptionAlert); // このメソッドを実行するには、ユーザーにアラートを表示するかどうかを選択します。Badge、Sound、alertの3種類を設定できます
}

// iOS 10 サポート
- (void)mtpNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler: (void (^)())completionHandler {
  // 必須
  NSDictionary * userInfo = response.notification.request.content.userInfo;
  if([response.notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) {
    [MTPushService handleRemoteNotification:userInfo];
  }
  else {
     // ローカル通知
  }
  completionHandler();  // システムはこのメソッドの実行を要求します
}

            

              
              // iOS 12 サポート
- (void)mtpNotificationCenter:(UNUserNotificationCenter *)center openSettingsForNotification:(UNNotification *)notification{
  if (notification) {
    //通知画面から直接アプリケーションに入る
  }else{
    //通知設定画面から直接アプリケーションに入る
  }
}

            

              
                  NSNotificationCenter *defaultCenter = [NSNotificationCenter defaultCenter];
    [defaultCenter addObserver:self selector:@selector(networkDidReceiveMessage:) name:kMTCNetworkDidReceiveMessageNotification object:nil];

            

              
                  - (void)networkDidReceiveMessage:(NSNotification *)notification {
        NSDictionary * userInfo = [notification userInfo];
        NSString *content = [userInfo valueForKey:@"content"];
        NSString *messageID = [userInfo valueForKey:@"_j_msgid"];
        NSDictionary *extras = [userInfo valueForKey:@"extras"]; 
        NSString *customizeField1 = [extras valueForKey:@"customizeField1"]; //サーバーから渡されたExtras追加フィールド、キーは独自に定義  
    }

            

              
              @interface AppDelegate ()<MTPushInAppMessageDelegate>

@end

            

              
              [MTPushService setInAppMessageDelegate:self];

            

              
              #pragma mark - MTPushInAppMessageDelegate
- (void)mtPushInAppMessageDidShow:(MTPushInAppMessage *)inAppMessage {
  NSString *mesageId = inAppMessage.mesageId;    // メッセージID
  NSString *title = inAppMessage.title;       // タイトル
  NSString *content = inAppMessage.content;     // コンテンツ
  NSArray  *target = inAppMessage.target;      // ターゲットページ
  NSString *clickAction = inAppMessage.clickAction; // クリックアクションURL
  NSDictionary *extras = inAppMessage.extras;  // 追加フィールド
  NSLog(@"InAppMessageDidShow:\n mesageId: %@ \n title:%@ \n content:%@ \n target:%@ \n clickAction:%@ \n extras:%@", mesageId, title, content, target, clickAction, extras);
}

- (void)mtPushInAppMessageDidClick:(MTPushInAppMessage *)inAppMessage {
  NSString *mesageId = inAppMessage.mesageId;    // メッセージID
  NSString *title = inAppMessage.title;       // タイトル
  NSString *content = inAppMessage.content;     // コンテンツ
  NSArray  *target = inAppMessage.target;      // ターゲットページ
  NSString *clickAction = inAppMessage.clickAction; // クリックアクションURL
  NSDictionary *extras = inAppMessage.extras;  // 追加フィールド
  NSLog(@"mtPushInAppMessageDidClick:\n mesageId: %@ \n title:%@ \n content:%@ \n target:%@ \n clickAction:%@ \n extras:%@", mesageId, title, content, target, clickAction, extras);
}

            

              
              @interface AppDelegate ()<MTPushNotiInMessageDelegate>

@end

            

              
                [MTPushService setNotiInMessageDelegate:self];

            

              
              #pragma mark - MTPushNotiInMessageDelegate
- (void)mtPushNotiInMessageDidShowWithContent:(NSDictionary *)content {
    NSString *messageID = [content valueForKey:@"_j_msgid"];
    NSDictionary *aps = [content valueForKey:@"aps"];
    id customizeField1 = [content valueForKey:@"customizeField1"]; // プッシュプラットフォームの詳細設定の追加フィールドキー
}

- (void)mtPushNotiInMessageDidClickWithContent:(NSDictionary *)content {
    NSString *messageID = [content valueForKey:@"_j_msgid"];
    NSDictionary *aps = [content valueForKey:@"aps"];
    id customizeField1 = [content valueForKey:@"customizeField1"]; // プッシュプラットフォームの詳細設定の追加フィールドキー
}

            

              
              + (void)registrationIDCompletionHandler:(void(^)(int resCode,NSString *registrationID))completionHandler;

            

              
              [MTPushService registrationIDCompletionHandler:^(int resCode, NSString *registrationID) {
    NSLog(@"resCode : %d,registrationID: %@",resCode,registrationID);
}];

            

              
              +(NSString *)registrationID

            

              
              + (BOOL)setBadge:(int)value

            

              
              + (void)resetBadge

            

              
              - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions; 
// ローカル通知コンテンツを取得：NSDictionary *localNotification = [launchOptions objectForKey: UIApplicationLaunchOptionsLocalNotificationKey]

            

              
              // NS_DEPRECATED_IOS(4_0, 10_0, "Use UserNotifications Framework's -[UNUserNotificationCenterDelegate willPresentNotification:withCompletionHandler:] or -[UNUserNotificationCenterDelegate didReceiveNotificationResponse:withCompletionHandler:]")
- (void)application:(UIApplication *)application didReceiveLocalNotification:(UILocalNotification *)notification;
//ローカル通知はnotificationです

            

              
              - (void)mtpNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^) (NSInteger))completionHandler; 
   // if (![notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) { 
   // ローカル通知はnotificationです
   // }

- (void)mtpNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler: (void (^)())completionHandler; 
  // if (![response.notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) { 
  // ローカル通知はnotificationです
  // }

            

              
              + (void)addNotification:(MTPushNotificationRequest *)request;

            

              
              - (void)testAddNotification {
  MTPushNotificationContent *content = [[MTPushNotificationContent alloc] init];
  content.title = @"Test Notifications";
  content.subtitle = @"2016";
  content.body = @"This is a test code";
  content.badge = @1;
  content.categoryIdentifier = @"Custom Category Name";
  
  // iOS 10以降で5秒後にアラート
  MTPushNotificationTrigger *trigger1 = [[MTPushNotificationTrigger alloc] init];
  trigger1.timeInterval = 5;
  //iOS 10 + サポートで1時間ごとに繰り返し
  MTPushNotificationTrigger *trigger2 = [[MTPushNotificationTrigger alloc] init];
  trigger2.timeInterval = 3600;
  trigger2.repeat = YES;
  
  //毎週月曜日午前8時にアラート、iOS 10以降でサポート
  NSDateComponents *components = [[NSDateComponents alloc] init];
  components.weekday = 2;
  components.hour = 8;
  MTPushNotificationTrigger *trigger3 = [[MTPushNotificationTrigger alloc] init];
  trigger3.dateComponents = components;
  trigger3.repeat = YES;
  
  //#import <CoreLocation/CoreLocation.h>
  //ある場所に到着したときにアラート、iOS 8以降でサポート
  CLLocationCoordinate2D cen = CLLocationCoordinate2DMake(37.335400, -122.009201);
  CLCircularRegion *region = [[CLCircularRegion alloc] initWithCenter:cen
                                                               radius:2000.0
                                                           identifier:@"engagelab"];
  MTPushNotificationTrigger *trigger4 = [[MTPushNotificationTrigger alloc] init];
  trigger4.region = region;
  
  //5秒後にアラート、iOS 10以下でサポート
  MTPushNotificationTrigger *trigger5 = [[MTPushNotificationTrigger alloc] init];
  trigger5.fireDate = [NSDate dateWithTimeIntervalSinceNow:5];

  MTPushNotificationRequest *request = [[MTPushNotificationRequest alloc] init];
  request.requestIdentifier = @"sampleRequest";
  request.content = content;
  request.trigger = trigger1;//trigger2;//trigger3;//trigger4;//trigger5;
  request.completionHandler = ^(id result) {
    NSLog(@"Results back：%@", result);
  };
  [MTPushService addNotification:request];
}

            

              
              + (void)removeNotification:(MTPushNotificationIdentifier *)identifier;

            

              
              - (void)testRemoveNotification {
  MTPushNotificationIdentifier *identifier = [[MTPushNotificationIdentifier alloc] init];
  identifier.identifiers = @[@"sampleRequest"];
  identifier.delivered = YES;  //YESに等しい場合、通知センターに表示されているものを削除します。NOに等しい場合、通知センターでプッシュされるものを削除します。iOS 10以下では無効です
  [MTPushService removeNotification:identifier];
}


- (void)testRemoveAllNotification {
  [MTPushService removeNotification:nil];  // iOS 10以下ですべてのプッシュを削除します。iOS 10以降では通知センターに表示されているすべてのプッシュとプッシュされるリクエストを削除します

//  //iOS 10以上をサポート
//  MTPushNotificationIdentifier *identifier = [[MTPushNotificationIdentifier alloc] init];
//  identifier.identifiers = nil;
//  identifier.delivered = YES;  //YESに等しい場合、通知センターに表示されているすべてを削除し、NOに等しい場合、プッシュされるすべてを削除します
//  [MTPushService removeNotification:identifier];
}

            

              
              + (void)findNotification:(MTPushNotificationIdentifier *)identifier;

            

              
              - (void)testFindNotification {
  MTPushNotificationIdentifier *identifier = [[MTPushNotificationIdentifier alloc] init];
  identifier.identifiers = @[@"sampleRequest"];
  identifier.delivered = YES;  //YESに等しい場合、通知センターに表示されているものを検索します。NOに等しい場合、通知センターでプッシュされるものを検索します。iOS10以下では無効です
  identifier.findCompletionHandler = ^(NSArray *results) {
  NSLog(@"The return result is：%@", results); // iOS10以下の場合、UILocalNotificationオブジェクトの配列が返されます。iOS10以上の場合、delivered値に基づいてUNNotificationまたはUNNotificationRequestオブジェクトの配列が返されます
};
  [MTPushService findNotification:identifier];
}

- (void)testFindAllNotification {
  MTPushNotificationIdentifier *identifier = [[MTPushNotificationIdentifier alloc] init];
  identifier.identifiers = nil;
  identifier.delivered = YES;  //iOS 10以上で有効です。YESは通知センターに表示されているすべてを検索し、NOはプッシュされるすべてを検索します。iOS 10以下では無効です
  identifier.findCompletionHandler = ^(NSArray *results) {
  NSLog(@"The return result is：%@", results); // iOS 10以下の場合、UILocalNotificationオブジェクトの配列が返されます。iOS 10以上の場合、delivered値に基づいてUNNotificationまたはUNNotificationRequestオブジェクトの配列が返されます
};
  [MTPushService findNotification:identifier];
}

            

              
              + (void)setDebugMode;

            

              
              [MTPushService setDebugMode];

            

              
              + (void)setLogOFF;

            

              
              [MTPushService setLogOFF];

            

              
              + (void)setMobileNumber:(NSString *)mobileNumber completion:(void (^)(NSError *error))completion

            

              
              [MTPushService setMobileNumber:@"xxx" completion:^(NSError *error) {
        if (error) {
          NSLog(@"error:%@", error);
        }
        else {
            // success
        }
      }];

            

              
              + (void)setUserLanguage:(NSString *)language completionHandler:(void(^)(int resCode, NSError *error))handler;

            

              
               [MTPushService setUserLanguage:@"zh_Hans" completionHandler:^(int resCode, NSError *error) {
    NSLog(@"language report: %d, %@", resCode, error);
  }];

            

              
                [MTPushService setTcpSSL:YES];

            

              
              + (void)setAppGroupId:(NSString *)appGroupId;

            

              
                [MTPushService setAppGroupId:@"Your appGroupId"];

            

              
              + (void)enablePushTextToSpeech:(BOOL)enable;

            

              
                [MTPushService enablePushTextToSpeech:YES];

            

              
              + (void)enableResetOnDeviceChange:(BOOL)enable;

            

              
                [MTPushService enableResetOnDeviceChange:YES];

            

              
                  + (void)registerLiveActivity:(NSString *)activityAttributes
            pushToStartToken:(NSData *)pushToStartToken
                  completion:(MTPLiveActivityTokenCompletion)completion
                        seq:(NSInteger)seq;

            

              
              
typedef void (^MTPUSHLiveActivityTokenCompletion)(NSInteger iResCode, NSString *liveActivityId, NSData *token, NSInteger seq);

            

              
                   + (void)registerLiveActivity:(NSString *)liveActivityId
                   pushToken:(NSData *)pushToken
                  completion:(MTPLiveActivityTokenCompletion)completion
                         seq:(NSInteger)seq;

            

              
              
typedef void (^MTPUSHLiveActivityTokenCompletion)(NSInteger iResCode, NSString *liveActivityId, NSData *token, NSInteger seq);

            

              
              + (void)registerVoipToken:(NSData *)voipToken;

            

              
              + (void)handleVoipNotification:(NSDictionary *)remoteInfo;

            

              
              + (void)unregisterVoipToken:(MTPushVoipTokenCompletion)completion;

            

              
              typedef void (^MTPushVoipTokenCompletion)(NSInteger iResCode, NSString *msg);

            

              
              + (void)registerVoipToken:(NSData *)voipToken;

            

              
              + (void)handleVoipNotification:(NSDictionary *)remoteInfo;

            

              
              + (void)mtpushSetAppkey:(NSString *)appkey

            

              
              + (void)mtpushReceiveNotificationRequest:(UNNotificationRequest *)request with:(void (^)(void))completion

            

              
              + (void)setLogOff

            

              
              + (void)mtpushSetAppGroupId:(NSString *)appGroupId;

            

              
              + (void)handleVoice:(UNNotificationRequest *)request with:(void (^)(NSString *soundName))completion;

            

              
              - (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {

  UNMutableNotificationContent *bestAttemptContent = [request.content mutableCopy];

  [MTNotificationExtensionService mtpushSetAppGroupId:@"xxx"];
  [MTNotificationExtensionService setSiteName:@"Your siteName"];  //バージョン4.3.5以降ではデータセンターを積極的に設定する必要はありません
  [MTNotificationExtensionService mtpushSetAppkey:@"Your appkey"];
  
  // 音声ファイルの処理
  [MTNotificationExtensionService handleVoice:request with:^(NSString *soundName) {
      if (soundName && soundName.length >= 0 ) {
        // 音声ファイルの処理が成功した後、通知の音声を処理された音声ファイル名に設定します
        bestAttemptContent.sound = [UNNotificationSound soundNamed:soundName];
      }
      // プッシュ統計報告APIの呼び出しを続けます
    [MTNotificationExtensionService mtpushReceiveNotificationRequest:request with:^ {
      NSLog(@"apns upload success");
      self.contentHandler(bestAttemptContent);
    }];
    
  }];

}