SDK API Guide
Anwendbare Version
Die in diesem Dokument behandelte Version des MTPush iOS SDK ist v3.0.0 oder höher.
Datenzentrum einrichten
Funktionsbeschreibung
Mit dieser Funktion legen Sie das im EngageLab-Portal ausgewählte Datenzentrum fest. Bitte stellen Sie sicher, dass das von Ihnen festgelegte Datenzentrum mit dem im Portal ausgewählten übereinstimmt.
Wird kein Datenzentrum angegeben, nutzt das SDK standardmäßig den Serverstandort in Singapur.
Ab Version v4.3.5 ist diese Schnittstelle nicht mehr gültig. Entwickler müssen diese Schnittstelle nicht mehr manuell aufrufen, um das Datenzentrum zu setzen. Das SDK ordnet das entsprechende Datenzentrum automatisch anhand des AppKey zu.
Unterstützte Versionen
Unterstützt ab Version: v4.3.0
Nicht mehr gültig ab
Ab Version: v4.3.5
Schnittstellendefinition
+ (void)setSiteName:(NSString *)siteName;
Parameterbeschreibung
siteName
- Name des Datenzentrums
Hinweise zum Aufruf
Bitte rufen Sie diese Schnittstelle vor der Initialisierung (setupWithOption:channel:apsForProduction:advertisingIdentifier) auf:
Tags- und Alias-API (iOS)
Funktionsbeschreibung
Hinweis: Bitte behandeln Sie das Callback-Ergebnis beim Setzen von Tag und Alias korrekt.
Nur wenn der Rückgabewert des Callbacks 0 ist, war das Setzen erfolgreich und das Versenden von Push-Benachrichtigungen an das Ziel ist möglich. Andernfalls gibt die Server-API einen Fehlercode 1011 zurück. Alle Callback-Funktionen werden im Hauptthread ausgeführt.
Mehrere APIs stehen zur Verwaltung von Aliasen und Tags zur Verfügung.
Diese APIs können an beliebiger Stelle in der App aufgerufen werden.
Alias
Ein Alias dient zur eindeutigen Identifizierung eines Nutzers, der die App installiert hat. Dieser Alias kann beim Versand von Push-Benachrichtigungen gezielt angesprochen werden.
Für jeden Nutzer kann nur ein Alias festgelegt werden.
Es wird empfohlen, für verschiedene Nutzer einer App unterschiedliche Aliase zu vergeben, um eine eindeutige Identifikation zu gewährleisten.
Beispiel: In einem Spiel kann der Alias als UserID gesetzt werden. Wenn festgestellt wird, dass ein Nutzer 3 Tage nicht gespielt hat, kann die Server-API über die UserID eine Benachrichtigung an den Client senden.
Tag
Mit Tags können Nutzer, die die App installiert haben, gekennzeichnet werden. Der Hauptzweck ist das gezielte Versenden von Push-Benachrichtigungen an Nutzergruppen.
Jeder Nutzer kann mehrere Tags erhalten.
Beispiel: game, old_page, women
Tags hinzufügen
Mit dieser API können Tags hinzugefügt werden. Das Ergebnis wird im Callback zurückgegeben.
Hinweis: Diese Schnittstelle ergänzt bestehende Tags, überschreibt jedoch keine bereits gesetzten.
Unterstützte Versionen
Unterstützt ab Version: v3.5.0.
Schnittstellendefinition
+ (void)addTags:(NSSet<NSString *> *)tags
completion:(MTPushTagsOperationCompletion)completion
seq:(NSInteger)seq;
Parameterbeschreibung
tags
- Darf nicht nil oder leer ([NSSet set]) sein
- Elemente müssen vom Typ NSString sein
- Mindestens ein Tag pro Aufruf setzen
- Gültige Zeichen: Buchstaben (Groß-/Kleinschreibung beachten), Zahlen, Unterstrich, chinesische Zeichen, Sonderzeichen @!#$&*+=.|
- Einschränkungen: Länge jedes Tag-Namens max. 40 Byte, max. 1.000 Tags, Gesamtlänge max. 5 KB (nach UTF-8)
- Ein Gerät unterstützt bis zu 1.000 Tags. Für globale App-Tags gibt es keine Begrenzung
completion
- Callback zur Rückgabe der gesetzten Tags und des Statuscodes: 0 bedeutet Erfolg, weitere Codes siehe Fehlercode-Definition. Die beim Aufruf übergebene Sessionnummer wird im Callback zurückgegeben.
seq
- Die beim Aufruf übergebene Sessionnummer wird beim Callback zurückgegeben.
Tags überschreiben
Mit dieser API werden alle bisherigen Tags überschrieben.
Unterstützte Versionen
Unterstützt ab Version: v3.5.0.
Schnittstellendefinition
+ (void)setTags:(NSSet<NSString *> *)tags
completion:(MTPushTagsOperationCompletion)completion
seq:(NSInteger)seq;
Parameterbeschreibung
tags
- Darf nicht nil oder leer ([NSSet set]) sein
- Elemente müssen NSString sein
- Mindestens ein Tag pro Aufruf
- Gültige Zeichen: Buchstaben (Groß-/Kleinschreibung beachten), Zahlen, Unterstrich, chinesische Zeichen, Sonderzeichen @!#$&*+=.|
- Einschränkungen: Länge pro Tag max. 40 Byte, max. 1.000 Tags, Gesamtlänge max. 5 KB (UTF-8)
- Ein Gerät unterstützt bis zu 1.000 Tags. Für globale App-Tags gibt es keine Begrenzung
completion
- Callback zur Rückgabe der gesetzten Tags und des Statuscodes: 0 bedeutet Erfolg, weitere Codes siehe Fehlercode-Definition. Die beim Aufruf übergebene Sessionnummer wird im Callback zurückgegeben.
seq
- Die beim Aufruf übergebene Sessionnummer wird beim Callback zurückgegeben.
Tags entfernen
Mit dieser API können Tags entfernt werden. Das Ergebnis wird im Callback zurückgegeben.
Unterstützte Versionen
Unterstützt ab Version: v3.5.0.
Schnittstellendefinition
+ (void)deleteTags:(NSSet<NSString *> *)tags
completion:(MTPushTagsOperationCompletion)completion
seq:(NSInteger)seq;
Parameterbeschreibung
tags
- Darf nicht nil oder leer ([NSSet set]) sein
- Elemente müssen NSString sein
- Mindestens ein Tag pro Aufruf löschen
- Gültige Zeichen: Buchstaben (Groß-/Kleinschreibung beachten), Zahlen, Unterstrich, chinesische Zeichen, Sonderzeichen @!#$&*+=.|
- Einschränkungen: Länge pro Tag max. 40 Byte, max. 1.000 Tags pro Aufruf, Gesamtlänge max. 5 KB (UTF-8)
completion
- Callback zur Rückgabe der entfernten Tags und des Statuscodes: 0 bedeutet Erfolg, weitere Codes siehe Fehlercode-Definition. Die beim Aufruf übergebene Sessionnummer wird im Callback zurückgegeben.
seq
- Die beim Aufruf übergebene Sessionnummer wird beim Callback zurückgegeben.
Tags leeren
Mit dieser API werden alle Tags entfernt. Das Ergebnis wird im Callback zurückgegeben.
Unterstützte Versionen
Unterstützt ab Version: v3.5.0.
Schnittstellendefinition
+ (void)cleanTags:(MTPushTagsOperationCompletion)completion
seq:(NSInteger)seq;
Parameterbeschreibung
completion
- Callback: Die Tags sind nil. Statuscode 0 bedeutet Erfolg, weitere Codes siehe Fehlercode-Definition. Die beim Aufruf übergebene Sessionnummer wird im Callback zurückgegeben.
seq
- Die beim Aufruf übergebene Sessionnummer wird beim Callback zurückgegeben.
Tags abfragen
Mit dieser API können alle Tags abgefragt werden. Das Ergebnis wird im Callback zurückgegeben.
Unterstützte Versionen
Unterstützt ab Version: v3.5.0.
Schnittstellendefinition
+ (void)getAllTags:(MTPushTagsOperationCompletion)completion
seq:(NSInteger)seq;
Parameterbeschreibung
completion
- Callback: Gibt die abgefragten Tags zurück. Statuscode 0 bedeutet Erfolg, weitere Codes siehe Fehlercode-Definition. Die beim Aufruf übergebene Sessionnummer wird im Callback zurückgegeben.
seq
- Die beim Aufruf übergebene Sessionnummer wird beim Callback zurückgegeben.
Tags validieren
Mit dieser API kann geprüft werden, ob ein bestimmter Tag gesetzt wurde.
Unterstützte Versionen
Unterstützt ab Version: v3.5.0.
Schnittstellendefinition
+ (void)validTag:(NSString *)tag
completion:(MTPushTagValidOperationCompletion)completion
seq:(NSInteger)seq;
Parameterbeschreibung
tag
- Darf nicht nil oder leer sein
- Gültige Zeichen: Buchstaben (Groß-/Kleinschreibung beachten), Zahlen, Unterstrich, chinesische Zeichen, Sonderzeichen @!#$&*+=.|
- Einschränkung: Länge max. 40 Byte (UTF-8)
completion
- Callback gibt Tag und Statuscode zurück: 0 bedeutet Erfolg, weitere Codes siehe Fehlercode-Definition. Die beim Aufruf übergebene Sessionnummer wird im Callback zurückgegeben.
- Überprüfen Sie das Attribut isBind im Callback: YES = gesetzt
seq
- Die beim Aufruf übergebene Sessionnummer wird beim Callback zurückgegeben.
Tags Callback-Definitionen
typedef void (^MTPushTagsOperationCompletion)(NSInteger iResCode, NSSet *iTags, NSInteger seq);
typedef void (^MTPushTagValidOperationCompletion)(NSInteger iResCode, NSSet *iTags, NSInteger seq, BOOL isBind);
Alias setzen
Mit dieser API kann ein Alias gesetzt werden.
Unterstützte Versionen
Unterstützt ab Version: v3.5.0.
Schnittstellendefinition
+ (void)setAlias:(NSString *)alias
completion:(MTPushAliasOperationCompletion)completion
seq:(NSInteger)seq;
Parameterbeschreibung
alias
- Darf nicht nil oder leer sein @""
- Jeder Aufruf überschreibt den bisherigen Alias
- Gültige Zeichen: Buchstaben (Groß-/Kleinschreibung beachten), Zahlen, Unterstrich, chinesische Zeichen, Sonderzeichen @!#$&*+=.|
- Einschränkung: Länge max. 40 Byte (UTF-8)
completion
- Callback gibt Alias und Statuscode zurück: 0 bedeutet Erfolg, weitere Codes siehe Fehlercode-Definition. Die beim Aufruf übergebene Sessionnummer wird im Callback zurückgegeben.
seq
- Die beim Aufruf übergebene Sessionnummer wird beim Callback zurückgegeben.
Alias entfernen
Mit dieser API kann ein Alias gelöscht werden. Das Ergebnis wird im Callback zurückgegeben.
Unterstützte Versionen
Unterstützt ab Version: v3.5.0.
Schnittstellendefinition
+ (void)deleteAlias:(MTPushAliasOperationCompletion)completion
seq:(NSInteger)seq;
Parameterbeschreibung
completion
- Callback gibt nil zurück. Statuscode 0 bedeutet Erfolg, weitere Codes siehe Fehlercode-Definition. Die beim Aufruf übergebene Sessionnummer wird im Callback zurückgegeben.
seq
- Die beim Aufruf übergebene Sessionnummer wird beim Callback zurückgegeben.
Alias abfragen
Mit dieser API kann der aktuelle Alias abgefragt werden. Das Ergebnis wird im Callback zurückgegeben.
Unterstützte Versionen
Unterstützt ab Version: v3.5.0.
Schnittstellendefinition
+ (void)getAlias:(MTPushAliasOperationCompletion)completion
seq:(NSInteger)seq;
Parameterbeschreibung
completion
- Callback gibt das Ergebnis der Abfrage zurück. Statuscode 0 bedeutet Erfolg, weitere Codes siehe Fehlercode-Definition. Die beim Aufruf übergebene Sessionnummer wird im Callback zurückgegeben.
seq
- Die beim Aufruf übergebene Sessionnummer wird beim Callback zurückgegeben.
Alias Callback-Definition
typedef void (^MTPushAliasOperationCompletion)(NSInteger iResCode, NSString *iAlias, NSInteger seq);
(Für weitere Abschnitte bitte anfragen!)
