https://github.com/icerockdev/fcm-push-service

Tools for sending fcm push by kotlin - part of BOKO libs
https://github.com/icerockdev/fcm-push-service

backend fcm kotlin kotlin-jvm push

Last synced: 21 days ago
JSON representation

Tools for sending fcm push by kotlin - part of BOKO libs

• Host: GitHub
• URL: https://github.com/icerockdev/fcm-push-service
• Owner: icerockdev
• License: apache-2.0
• Created: 2019-12-02T07:13:20.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2025-06-24T05:05:07.000Z (10 months ago)
• Last Synced: 2025-06-24T06:24:23.005Z (10 months ago)
• Topics: backend, fcm, kotlin, kotlin-jvm, push
• Language: Kotlin
• Homepage:
• Size: 179 KB
• Stars: 5
• Watchers: 6
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Fcm push service

## **NOTE. Only sending with device tokens is supported**

## Installation

````kotlin

// Append repository

repositories {

    mavenCentral()

}

// Append dependency

implementation("com.icerockdev.service:fcm-push-service:2.2.0")

````

## Koin configure

### include dependency

````kotlin

val fcmScope = CoroutineScope(Dispatchers.IO + SupervisorJob())

single {

    PushService(

        coroutineScope = fcmScope,

        config = FCMConfig(

            googleServiceAccountJson = appConf.getString("fcm.googleServiceAccountJson")

        ),

        pushRepository = object : IPushRepository {

            override fun deleteByTokenList(tokenList: List): Int {

                // remove wrong tokens here

                return 0

            }

        }

    )

}

````

````kotlin

class Container : KoinComponent {

    val pushService: PushService by inject()

}

````

````

// application.conf

fcm {

    googleServiceAccountJson = ${GOOGLE_SERVICE_ACCOUNT_JSON}

}

````

## Send data example

````kotlin

pushService.sendAsync(

    payLoad = FCMPayLoad(

        dataObject = data,

        notificationObject = notification,

        tokenList = tokens

    )

)

````

## Send data with an example of receiving a response

````kotlin

val result: PushResult = pushService.sendAsync(

    payLoad = FCMPayLoad(

        dataObject = data,

        notificationObject = notification,

        tokenList = tokens

    )

).await()

````

## Contributing

All development (both new features and bug fixes) is performed in the `develop` branch. This way `master` always contains the sources of the most recently released version. Please send PRs with bug fixes to the `develop` branch. Documentation fixes in the markdown files are an exception to this rule. They are updated directly in `master`.

The `develop` branch is pushed to `master` on release.

For more details on contributing please see the [contributing guide](CONTRIBUTING.md).

## License

        

    Copyright 2019 IceRock MAG Inc.

    

    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

    

       http://www.apache.org/licenses/LICENSE-2.0

    

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.