Push Notifications - Revision history

80.229.4.125: /* Community Backend Testing */

2024-07-15T12:40:02Z

Community Backend Testing

← Older revision		Revision as of 12:40, 15 July 2024
Line 152:		Line 152:
	Once all is setup and the app is running, it should register itself with the community for push notifications		Once all is setup and the app is running, it should register itself with the community for push notifications

	You can check this by running the following in the editor sandbox on the community, ~~where xxxx is~~ the userid		You can check this by running the following in the editor sandbox on the community, passing in the relevant userid

			<syntaxhighlight>
			$mwa_v1_push.List({userid})
			</syntaxhighlight>

	~~$mwa_v1_push.List(xxxx)~~
	You should get a list of the devices/browsers linked to the user (y4es browser as running as ss in browser will also register)		You should get a list of the devices/browsers linked to the user (y4es browser as running as ss in browser will also register)

Line 180:		Line 183:
	Count: 3 [Int32]		Count: 3 [Int32]

			</syntaxhighlight>

			In the app itself you can see the device id via the about screen

			To send a test message to your device you can use the sandbox again

			<syntaxhighlight>
			$mwa_v1_push.Test({notificationKey})
	</syntaxhighlight>		</syntaxhighlight>

80.229.4.125: /* Community Backend Testing */

2024-07-15T12:10:36Z

Community Backend Testing

← Older revision		Revision as of 12:10, 15 July 2024
Line 150:		Line 150:
	=== Community Backend Testing ===		=== Community Backend Testing ===

	Once all is setup and the app is running, it should register ~~itseldf~~ with the community for push notifications		Once all is setup and the app is running, it should register itself with the community for push notifications

	You can check this by running the following in the editor sandbox on the community, where xxxx is the userid		You can check this by running the following in the editor sandbox on the community, where xxxx is the userid
Line 181:		Line 181:

	</syntaxhighlight>		</syntaxhighlight>



	=== Backend Integration ===		=== Backend Integration ===

80.229.4.125 at 11:59, 15 July 2024

2024-07-15T11:59:29Z

← Older revision		Revision as of 11:59, 15 July 2024
Line 120:		Line 120:
	web		web

	=== Backend Authentication ===		=== Community Backend Authentication ===

	Create a service account via https://console.cloud.google.com/projectselector2/iam-admin/serviceaccounts?supportedpurview=project		Create a service account via https://console.cloud.google.com/projectselector2/iam-admin/serviceaccounts?supportedpurview=project
Line 147:		Line 147:
	?		?
	</syntaxhighlight>		</syntaxhighlight>

			=== Community Backend Testing ===

			Once all is setup and the app is running, it should register itseldf with the community for push notifications

			You can check this by running the following in the editor sandbox on the community, where xxxx is the userid

			$mwa_v1_push.List(xxxx)
			You should get a list of the devices/browsers linked to the user (y4es browser as running as ss in browser will also register)

			e.g.

			<syntaxhighlight>

			[List-of-UserDevice]

			[0] [UserDevice]
			DeviceId: "30320502008403" [String]
			NotificationKey: "eRLAz76oKlkaclmsOIHjqj:APA91bEhrSbBLADxMLagqucznK5W06dx0JoMxGGwH-XVEZD6kdKdJll7JjVKjHJgpJbc8lSiq_on1j1_t0Puthn7wNKPJpxUnhSNxEVMkBMcq2T_CaZ0YyAGIljgkvp86OC5cLTz1r-j" [String]
			NotificationKeyType: "web" [String]

			[1] [UserDevice]
			DeviceId: "09965002900340" [String]
			NotificationKey: "dhC63MgrSyqsi1ilkkwnax:APA91bHuPEAeiFiSHnuTPUs7cQ1J6EP_Fl0x3zxX8jaxqBhQPQKTxOPl72KbH1ZR3-h1_WWI4RzFX2k3RwXcwoX8fNm_rHFm5OOeUGoBV3BkwXB3keVbCXDRWx0AWApxZZoK2x1-78kT" [String]
			NotificationKeyType: "firebase" [String]

			[2] [UserDevice]
			DeviceId: "00000019000" [String]
			NotificationKey: "cldvQ2LES5C36bo9QQ52MQ:APA91bElxPKDdbt_rBRJZsMf02JqrK7RdgBfZm1pYCDKcmVSmwYok1exNWpaU6If5B0yTRlB6o7RnHFWybnLF2zNqXvmE6S6_Lb7nfshK0yTB_qCzQFlOsAdwdoLB8L-tNXMgLnp1cj1" [String]
			NotificationKeyType: "firebase" [String]

			Count: 3 [Int32]

			</syntaxhighlight>



	=== Backend Integration ===		=== Backend Integration ===

80.229.4.125: /* Setup a new project in firebase */

2024-07-15T10:43:07Z

Setup a new project in firebase

← Older revision		Revision as of 10:43, 15 July 2024
Line 11:		Line 11:

	https://firebase.google.com/docs/web/setup		https://firebase.google.com/docs/web/setup

	https://firebase.google.com/docs/android/setup		https://firebase.google.com/docs/android/setup

			https://learn.buildfire.com/en/articles/2060582-how-to-set-up-your-firebase-certificates-for-ios-and-android

	Create apps for ios, android and web as required		Create apps for ios, android and web as required

80.229.4.125: /* Setup a new project in firebase */

2024-07-04T12:59:06Z

Setup a new project in firebase

← Older revision		Revision as of 12:59, 4 July 2024
Line 10:		Line 10:
	=== Setup a new project in firebase ===		=== Setup a new project in firebase ===

			https://firebase.google.com/docs/web/setup
	https://firebase.google.com/docs/android/setup		https://firebase.google.com/docs/android/setup

80.229.4.125: /* Update your application */

2024-07-04T08:34:23Z

Update your application

← Older revision		Revision as of 08:34, 4 July 2024
Line 33:		Line 33:

	</plugin>		</plugin>

			see the official plugin page for more info

			https://www.npmjs.com/package/cordova-plugin-firebase-messaging

	=== Get the firebase config files ===		=== Get the firebase config files ===

80.229.4.125: /* Update your application */

2024-07-04T08:31:00Z

Update your application

← Older revision		Revision as of 08:31, 4 July 2024
Line 17:		Line 17:

	Add the following plugin into the config.xml in the App folder		Add the following plugin into the config.xml in the App folder

			In the <platform name="android">section you will need to reference the icon colours for notifications

			<config-file parent="/manifest/application/" target="app/src/main/AndroidManifest.xml">
			<meta-data android:name="com.google.firebase.messaging.default_notification_icon" android:resource="@drawable/notification_icon" />
			<meta-data android:name="com.google.firebase.messaging.default_notification_color" android:resource="@color/defaultNotificationColor" />
			</config-file>


	<plugin name="cordova-plugin-firebase-messaging" spec="~4.3.1">		<plugin name="cordova-plugin-firebase-messaging" spec="~4.3.1">

2A02:C7C:C43F:C600:2505:4C62:1C31:494D: /* Add a UI handler for the messaging */

2024-05-27T18:27:19Z

Add a UI handler for the messaging

← Older revision		Revision as of 18:27, 27 May 2024
Line 61:		Line 61:
	=== Add a UI handler for the messaging ===		=== Add a UI handler for the messaging ===

	~~Find an existing example in devops~~		Install the push notifications UI module:

	UI/PushNotifications		<syntaxhighlight lang="bash">
			socialstack install UI/PushNotifications
			</syntaxhighlight>

	~~Alter~~ the ~~PushRegister~~.js file to include the correct firebase config from the web application ~~(see THE-COM-MAP for an example), this will be~~ used ~~to get a key in~~ web ~~mode and allow for quick testing of your backend~~		This module has the main job of registering for push notifications when the device is either in a native app or via the web. A device on the web will see the permission request for push notifications.

			You'll need to edit the PushNotifications.js file to include the correct firebase config from the web application. This config is primarily used when your site is running from the web.

	=== Add a settings page to your local wep app ===		=== Add a settings page to your local wep app ===

2A02:C7C:C43F:C600:2505:4C62:1C31:494D: /* Backend Integration */

2024-05-27T18:16:42Z

Backend Integration

← Older revision		Revision as of 18:16, 27 May 2024
Line 130:		Line 130:
	=== Backend Integration ===		=== Backend Integration ===

	~~Using~~ the ~~client key you should be able to create a simple c# app using the firebase nuget package to send a test message~~		Start by installing the push notifications module:

	~~https:~~//~~github.com/Firebase/firebase-admin-dotnet~~		<syntaxhighlight lang="bash">
			socialstack install Api/PushNotifications
			</syntaxhighlight>

	~~or see~~ the ~~repo~~		This module creates the UserDevice type and also provides the PushNotificationService which can be used to send push notifications to target devices.

	~~https://4-roads.visualstudio.com/INT-TEL-APP~~		Internally the PushNotificationService batches notifications together so can be used for large amounts of push notification traffic too.

	~~The webapp communicates via a rest api~~

	~~https://{hostname}/api.ashx/v2/mwa/user/device/add~~

	~~All requests are logged to~~ the ~~community event log if you look for category "MWA Notifications",~~ so ~~you should~~ be ~~able to see them coming in from the app~~

	~~By default the community mwa extension will forward any community notifications to the app via firebase if the user has a valid key, which are stored in extended attributes~~ of ~~the user account~~

	=== IOS APNS Key Setup ===		=== IOS APNS Key Setup ===

2A02:C7C:C43F:C600:2505:4C62:1C31:494D: /* IOS APNS Key Setup */

2024-05-27T17:57:14Z

IOS APNS Key Setup

← Older revision		Revision as of 17:57, 27 May 2024
Line 148:		Line 148:
	=== IOS APNS Key Setup ===		=== IOS APNS Key Setup ===

	To access ~~ios~~ clients you will need to get a key ~~fromteh apple~~ developer site and upload it into firebase		To access iOS clients you will need to get a key from the Apple developer site and upload it into firebase:

	https://learn.buildfire.com/en/articles/5760994-how-to-set-up-your-apple-push-notification-key-for-your-ios-firebase-certificate#:~:text=How%20do%20I%20upload%20my%20APNs%20key%20to,Step%203.%20Click%20on%20Certificates%2C%20IDs%20%26%20Profiles		https://learn.buildfire.com/en/articles/5760994-how-to-set-up-your-apple-push-notification-key-for-your-ios-firebase-certificate#:~:text=How%20do%20I%20upload%20my%20APNs%20key%20to,Step%203.%20Click%20on%20Certificates%2C%20IDs%20%26%20Profiles