mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2026-08-04 00:00:08 +08:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
667d31fa80 |
@@ -35,7 +35,7 @@ declare const window: Window & { Airship: any };
|
||||
pluginName: 'Airship',
|
||||
plugin: '@ua/cordova-airship',
|
||||
pluginRef: 'Airship',
|
||||
repo: 'https://www.npmjs.com/package/@ua/cordova-airship',
|
||||
repo: 'https://github.com/urbanairship/urbanairship-cordova',
|
||||
install: 'ionic cordova plugin add @ua/cordova-airship',
|
||||
platforms: ['Android', 'iOS'],
|
||||
})
|
||||
@@ -52,6 +52,14 @@ export class Airship extends AwesomeCordovaNativePlugin {
|
||||
public preferenceCenter: AirshipPreferenceCenter;
|
||||
public privacyManager: AirshipPrivacyManager;
|
||||
public push: AirshipPush;
|
||||
/**
|
||||
* Live Activity manager. iOS only.
|
||||
*/
|
||||
public liveActivityManager: AirshipLiveActivityManager;
|
||||
/**
|
||||
* Live Update manager. Android only.
|
||||
*/
|
||||
public liveUpdateManager: AirshipLiveUpdateManager;
|
||||
|
||||
/**
|
||||
* Call after platform ready
|
||||
@@ -257,6 +265,252 @@ export interface DisplayPreferenceCenterEvent {
|
||||
preferenceCenterId: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Event fired when Live Activities are updated. iOS only.
|
||||
*/
|
||||
export interface LiveActivitiesUpdatedEvent {
|
||||
/**
|
||||
* The Live Activities.
|
||||
*/
|
||||
activities: LiveActivity[];
|
||||
}
|
||||
|
||||
/**
|
||||
* Live Activity info. iOS only.
|
||||
*/
|
||||
export interface LiveActivity {
|
||||
/**
|
||||
* The activity ID.
|
||||
*/
|
||||
id: string;
|
||||
/**
|
||||
* The attribute types.
|
||||
*/
|
||||
attributeTypes: string;
|
||||
/**
|
||||
* The content.
|
||||
*/
|
||||
content: LiveActivityContent;
|
||||
/**
|
||||
* The attributes.
|
||||
*/
|
||||
attributes: JsonObject;
|
||||
}
|
||||
|
||||
/**
|
||||
* Live Activity content. iOS only.
|
||||
*/
|
||||
export interface LiveActivityContent {
|
||||
/**
|
||||
* The content state.
|
||||
*/
|
||||
state: JsonObject;
|
||||
/**
|
||||
* Optional ISO 8601 date string that defines when the Live Activity will be stale.
|
||||
*/
|
||||
staleDate?: string;
|
||||
/**
|
||||
* The relevance score.
|
||||
*/
|
||||
relevanceScore: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Base Live Activity request. iOS only.
|
||||
*/
|
||||
export interface LiveActivityRequest {
|
||||
/**
|
||||
* Attributes type. This should match the Activity type of your Live Activity.
|
||||
*/
|
||||
attributesType: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Live Activity list request. iOS only.
|
||||
*/
|
||||
export type LiveActivityListRequest = LiveActivityRequest;
|
||||
|
||||
/**
|
||||
* Live Activity start request. iOS only.
|
||||
*/
|
||||
export interface LiveActivityStartRequest extends LiveActivityRequest {
|
||||
/**
|
||||
* Dynamic content.
|
||||
*/
|
||||
content: LiveActivityContent;
|
||||
/**
|
||||
* Fixed attributes.
|
||||
*/
|
||||
attributes: JsonObject;
|
||||
}
|
||||
|
||||
/**
|
||||
* Live Activity update request. iOS only.
|
||||
*/
|
||||
export interface LiveActivityUpdateRequest extends LiveActivityRequest {
|
||||
/**
|
||||
* The Live Activity ID to update.
|
||||
*/
|
||||
activityId: string;
|
||||
/**
|
||||
* Dynamic content.
|
||||
*/
|
||||
content: LiveActivityContent;
|
||||
}
|
||||
|
||||
/**
|
||||
* Live Activity end request. iOS only.
|
||||
*/
|
||||
export interface LiveActivityEndRequest extends LiveActivityRequest {
|
||||
/**
|
||||
* The Live Activity ID to end.
|
||||
*/
|
||||
activityId: string;
|
||||
/**
|
||||
* Dynamic content.
|
||||
*/
|
||||
content?: LiveActivityContent;
|
||||
/**
|
||||
* Dismissal policy. Defaults to `LiveActivityDismissalPolicyDefault`.
|
||||
*/
|
||||
dismissalPolicy?: LiveActivityDismissalPolicy;
|
||||
}
|
||||
|
||||
export type LiveActivityDismissalPolicy =
|
||||
LiveActivityDismissalPolicyImmediate | LiveActivityDismissalPolicyDefault | LiveActivityDismissalPolicyAfterDate;
|
||||
|
||||
/**
|
||||
* Dismissal policy to immediately dismiss the Live Activity on end.
|
||||
*/
|
||||
export interface LiveActivityDismissalPolicyImmediate {
|
||||
type: 'immediate';
|
||||
}
|
||||
|
||||
/**
|
||||
* Dismissal policy to dismiss the Live Activity after the expiration.
|
||||
*/
|
||||
export interface LiveActivityDismissalPolicyDefault {
|
||||
type: 'default';
|
||||
}
|
||||
|
||||
/**
|
||||
* Dismissal policy to dismiss the Live Activity after a given date.
|
||||
*/
|
||||
export interface LiveActivityDismissalPolicyAfterDate {
|
||||
type: 'after';
|
||||
/**
|
||||
* ISO 8601 date string.
|
||||
*/
|
||||
date: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Live Update info. Android only.
|
||||
*/
|
||||
export interface LiveUpdate {
|
||||
/**
|
||||
* The Live Update name.
|
||||
*/
|
||||
name: string;
|
||||
/**
|
||||
* The Live Update type.
|
||||
*/
|
||||
type: string;
|
||||
/**
|
||||
* Dynamic content.
|
||||
*/
|
||||
content: JsonObject;
|
||||
/**
|
||||
* ISO 8601 date string of the last content update.
|
||||
*/
|
||||
lastContentUpdateTimestamp: string;
|
||||
/**
|
||||
* ISO 8601 date string of the last state update.
|
||||
*/
|
||||
lastStateChangeTimestamp: string;
|
||||
/**
|
||||
* Optional ISO 8601 date string that defines when to end this Live Update.
|
||||
*/
|
||||
dismissTimestamp?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Live Update list request. Android only.
|
||||
*/
|
||||
export interface LiveUpdateListRequest {
|
||||
type: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Live Update start request. Android only.
|
||||
*/
|
||||
export interface LiveUpdateStartRequest {
|
||||
/**
|
||||
* The Live Update name.
|
||||
*/
|
||||
name: string;
|
||||
/**
|
||||
* The Live Update type.
|
||||
*/
|
||||
type: string;
|
||||
/**
|
||||
* Dynamic content.
|
||||
*/
|
||||
content: JsonObject;
|
||||
/**
|
||||
* Optional ISO 8601 date string, used to filter out of order updates.
|
||||
*/
|
||||
timestamp?: string;
|
||||
/**
|
||||
* Optional ISO 8601 date string that defines when to end this Live Update.
|
||||
*/
|
||||
dismissTimestamp?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Live Update update request. Android only.
|
||||
*/
|
||||
export interface LiveUpdateUpdateRequest {
|
||||
/**
|
||||
* The Live Update name.
|
||||
*/
|
||||
name: string;
|
||||
/**
|
||||
* Dynamic content.
|
||||
*/
|
||||
content: JsonObject;
|
||||
/**
|
||||
* Optional ISO 8601 date string, used to filter out of order updates.
|
||||
*/
|
||||
timestamp?: string;
|
||||
/**
|
||||
* Optional ISO 8601 date string that defines when to end this Live Update.
|
||||
*/
|
||||
dismissTimestamp?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Live Update end request. Android only.
|
||||
*/
|
||||
export interface LiveUpdateEndRequest {
|
||||
/**
|
||||
* The Live Update name.
|
||||
*/
|
||||
name: string;
|
||||
/**
|
||||
* Dynamic content.
|
||||
*/
|
||||
content?: JsonObject;
|
||||
/**
|
||||
* Optional ISO 8601 date string, used to filter out of order updates.
|
||||
*/
|
||||
timestamp?: string;
|
||||
/**
|
||||
* Optional ISO 8601 date string that defines when to end this Live Update.
|
||||
*/
|
||||
dismissTimestamp?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* iOS options
|
||||
*/
|
||||
@@ -448,6 +702,18 @@ export interface ConfigEnvironment {
|
||||
* Optional log level.
|
||||
*/
|
||||
logLevel?: LogLevel;
|
||||
|
||||
/**
|
||||
* Optional iOS config.
|
||||
*/
|
||||
ios?: {
|
||||
/**
|
||||
* Log privacy level. By default it logs at `private`, not logging anything lower than info to the console
|
||||
* and redacting logs with string interpolation. `public` will log all configured log levels to the console
|
||||
* without redacting any of the log lines.
|
||||
*/
|
||||
logPrivacyLevel?: 'private' | 'public';
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -619,12 +885,14 @@ export namespace Android {
|
||||
* Enum of authorized Features.
|
||||
*/
|
||||
export enum Feature {
|
||||
All = 'all',
|
||||
InAppAutomation = 'in_app_automation',
|
||||
MessageCenter = 'message_center',
|
||||
Push = 'push',
|
||||
Analytics = 'analytics',
|
||||
TagsAndAttributes = 'tags_and_attributes',
|
||||
Contacts = 'contacts',
|
||||
FeatureFlags = 'feature_flags',
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -996,6 +1264,17 @@ export interface AttributeEditor {
|
||||
*/
|
||||
setAttribute(name: string, value: string | number | boolean | Date): AttributeEditor;
|
||||
|
||||
/**
|
||||
* Adds a JSON attribute.
|
||||
*
|
||||
* @param name The attribute name.
|
||||
* @param instanceId The instance ID.
|
||||
* @param json The json value. Must not contain `exp` as top level key.
|
||||
* @param expiration Optional expiration.
|
||||
* @return The attribute editor instance.
|
||||
*/
|
||||
setJsonAttribute(name: string, instanceId: string, json: Record<string, any>, expiration?: Date): AttributeEditor;
|
||||
|
||||
/**
|
||||
* Removes an attribute.
|
||||
* @param name The name of the attribute to remove.
|
||||
@@ -1003,6 +1282,14 @@ export interface AttributeEditor {
|
||||
*/
|
||||
removeAttribute(name: string): AttributeEditor;
|
||||
|
||||
/**
|
||||
* Removes a JSON attribute.
|
||||
* @param name The name of the attribute to remove.
|
||||
* @param instanceId The instance ID.
|
||||
* @return The attribute editor instance.
|
||||
*/
|
||||
removeJsonAttribute(name: string, instanceId: string): AttributeEditor;
|
||||
|
||||
/**
|
||||
* Applies the attribute operations.
|
||||
* @param success Success callback.
|
||||
@@ -1044,6 +1331,15 @@ class AirshipPush {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enables user notifications and prompts the user for permission, if needed.
|
||||
* @returns Whether user notifications are enabled after the request.
|
||||
*/
|
||||
@CordovaInstance()
|
||||
enableUserNotifications(): Promise<boolean> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the notification status.
|
||||
*/
|
||||
@@ -1186,6 +1482,13 @@ export interface AirshipPushIOS {
|
||||
*/
|
||||
getBadgeNumber(success: (badge: number) => void, error?: (err: string) => void): void;
|
||||
|
||||
/**
|
||||
* Resets the badge number to zero.
|
||||
* @param success Success callback.
|
||||
* @param error Error callback.
|
||||
*/
|
||||
resetBadge(success?: () => void, error?: (err: string) => void): void;
|
||||
|
||||
/**
|
||||
* Gets the list of authorized notification settings.
|
||||
* @param success Success callback.
|
||||
@@ -1550,6 +1853,41 @@ export interface AirshipFeatureFlagManager {
|
||||
trackInteraction(flag: FeatureFlag, success?: () => void, error?: (err: string) => void): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* Options for email channel registration.
|
||||
*/
|
||||
export interface EmailRegistrationOptions {
|
||||
/**
|
||||
* Transactional opt-in date as milliseconds since epoch.
|
||||
*/
|
||||
transactionalOptedIn?: number;
|
||||
|
||||
/**
|
||||
* Commercial opt-in date as milliseconds since epoch.
|
||||
*/
|
||||
commercialOptedIn?: number;
|
||||
|
||||
/**
|
||||
* Custom properties for the email channel.
|
||||
*/
|
||||
properties?: Record<string, string>;
|
||||
|
||||
/**
|
||||
* Request double opt-in for commercial messages when `commercialOptedIn` is not set.
|
||||
*/
|
||||
doubleOptIn?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Options for SMS channel registration.
|
||||
*/
|
||||
export interface SmsRegistrationOptions {
|
||||
/**
|
||||
* The sender ID.
|
||||
*/
|
||||
senderId: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Airship contact.
|
||||
*/
|
||||
@@ -1620,6 +1958,26 @@ class AirshipContact {
|
||||
reset(): Promise<void> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers an email channel for the contact.
|
||||
* @param email The email address.
|
||||
* @param options Registration options.
|
||||
*/
|
||||
@CordovaInstance()
|
||||
registerEmail(email: string, options: EmailRegistrationOptions): Promise<void> {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers an SMS channel for the contact.
|
||||
* @param msisdn The MSISDN, including country code.
|
||||
* @param options Registration options.
|
||||
*/
|
||||
@CordovaInstance()
|
||||
registerSMS(msisdn: string, options: SmsRegistrationOptions): Promise<void> {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -1765,3 +2123,114 @@ export interface AirshipActions {
|
||||
error?: (err: string) => void
|
||||
): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* Live Activity manager. iOS only.
|
||||
*/
|
||||
export interface AirshipLiveActivityManager {
|
||||
/**
|
||||
* Lists any Live Activities for the request.
|
||||
* @param request The request options.
|
||||
* @param success Success callback with the list.
|
||||
* @param error Error callback.
|
||||
*/
|
||||
list(
|
||||
request: LiveActivityListRequest,
|
||||
success: (activities: LiveActivity[]) => void,
|
||||
error?: (err: string) => void
|
||||
): void;
|
||||
|
||||
/**
|
||||
* Lists all Live Activities.
|
||||
* @param success Success callback with the list.
|
||||
* @param error Error callback.
|
||||
*/
|
||||
listAll(success: (activities: LiveActivity[]) => void, error?: (err: string) => void): void;
|
||||
|
||||
/**
|
||||
* Starts a Live Activity.
|
||||
* @param request The request options.
|
||||
* @param success Success callback with the started activity.
|
||||
* @param error Error callback.
|
||||
*/
|
||||
start(
|
||||
request: LiveActivityStartRequest,
|
||||
success: (activity: LiveActivity) => void,
|
||||
error?: (err: string) => void
|
||||
): void;
|
||||
|
||||
/**
|
||||
* Updates a Live Activity.
|
||||
* @param request The request options.
|
||||
* @param success Success callback.
|
||||
* @param error Error callback.
|
||||
*/
|
||||
update(request: LiveActivityUpdateRequest, success?: () => void, error?: (err: string) => void): void;
|
||||
|
||||
/**
|
||||
* Ends a Live Activity.
|
||||
* @param request The request options.
|
||||
* @param success Success callback.
|
||||
* @param error Error callback.
|
||||
*/
|
||||
end(request: LiveActivityEndRequest, success?: () => void, error?: (err: string) => void): void;
|
||||
|
||||
/**
|
||||
* Live Activities updated listener.
|
||||
*
|
||||
* @param callback The callback.
|
||||
* @return A cancellable that can be used to cancel the listener.
|
||||
*/
|
||||
onLiveActivitiesUpdated(callback: (event: LiveActivitiesUpdatedEvent) => void): Cancellable;
|
||||
}
|
||||
|
||||
/**
|
||||
* Live Update manager. Android only.
|
||||
*/
|
||||
export interface AirshipLiveUpdateManager {
|
||||
/**
|
||||
* Lists any Live Updates for the request.
|
||||
* @param request The request options.
|
||||
* @param success Success callback with the list.
|
||||
* @param error Error callback.
|
||||
*/
|
||||
list(request: LiveUpdateListRequest, success: (updates: LiveUpdate[]) => void, error?: (err: string) => void): void;
|
||||
|
||||
/**
|
||||
* Lists all Live Updates.
|
||||
* @param success Success callback with the list.
|
||||
* @param error Error callback.
|
||||
*/
|
||||
listAll(success: (updates: LiveUpdate[]) => void, error?: (err: string) => void): void;
|
||||
|
||||
/**
|
||||
* Starts a Live Update.
|
||||
* @param request The request options.
|
||||
* @param success Success callback.
|
||||
* @param error Error callback.
|
||||
*/
|
||||
start(request: LiveUpdateStartRequest, success?: () => void, error?: (err: string) => void): void;
|
||||
|
||||
/**
|
||||
* Updates a Live Update.
|
||||
* @param request The request options.
|
||||
* @param success Success callback.
|
||||
* @param error Error callback.
|
||||
*/
|
||||
update(request: LiveUpdateUpdateRequest, success?: () => void, error?: (err: string) => void): void;
|
||||
|
||||
/**
|
||||
* Ends a Live Update.
|
||||
* @param request The request options.
|
||||
* @param success Success callback.
|
||||
* @param error Error callback.
|
||||
*/
|
||||
end(request: LiveUpdateEndRequest, success?: () => void, error?: (err: string) => void): void;
|
||||
|
||||
/**
|
||||
* Clears all Live Updates.
|
||||
* @param success Success callback.
|
||||
* @param error Error callback.
|
||||
*/
|
||||
clearAll(success?: () => void, error?: (err: string) => void): void;
|
||||
}
|
||||
|
||||
@@ -18,7 +18,6 @@ export enum Connection {
|
||||
CELL_2G = '2g',
|
||||
CELL_3G = '3g',
|
||||
CELL_4G = '4g',
|
||||
CELL_5G = '5g',
|
||||
CELL = 'cellular',
|
||||
NONE = 'none',
|
||||
}
|
||||
@@ -63,7 +62,7 @@ export enum Connection {
|
||||
*
|
||||
* ```
|
||||
* @advanced
|
||||
* The `type` property will return one of the following connection types: `unknown`, `ethernet`, `wifi`, `2g`, `3g`, `4g`, `5g`, `cellular`, `none`
|
||||
* The `type` property will return one of the following connection types: `unknown`, `ethernet`, `wifi`, `2g`, `3g`, `4g`, `cellular`, `none`
|
||||
*/
|
||||
@Plugin({
|
||||
pluginName: 'Network',
|
||||
@@ -84,7 +83,6 @@ export class Network extends AwesomeCordovaNativePlugin {
|
||||
CELL_2G: '2g',
|
||||
CELL_3G: '3g',
|
||||
CELL_4G: '4g',
|
||||
CELL_5G: '5g',
|
||||
CELL: 'cellular',
|
||||
NONE: 'none',
|
||||
};
|
||||
@@ -100,7 +98,6 @@ export class Network extends AwesomeCordovaNativePlugin {
|
||||
* Downlink Max Speed
|
||||
*
|
||||
* @returns {string}
|
||||
* @deprecated Not part of the upstream cordova-plugin-network-information API (verified against v3.1.0 types/index.d.ts and README). Retained for backwards compatibility only.
|
||||
*/
|
||||
@CordovaProperty() downlinkMax: string;
|
||||
|
||||
@@ -112,7 +109,7 @@ export class Network extends AwesomeCordovaNativePlugin {
|
||||
@CordovaCheck()
|
||||
onChange(): Observable<'connected' | 'disconnected'> {
|
||||
return merge(
|
||||
this.onConnect().pipe(mapTo('connected')) as Observable<'connected'>,
|
||||
this.onConnect().pipe(mapTo('connected')),
|
||||
this.onDisconnect().pipe(mapTo('disconnected')) as Observable<'disconnected'>
|
||||
);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user