Skip to content

Latest commit

 

History

History
94 lines (76 loc) · 2.51 KB

README.md

File metadata and controls

94 lines (76 loc) · 2.51 KB
Raw

Fcm push service

NOTE. Only sending with device tokens is supported

Installation

// Append repository
repositories {
    mavenCentral()
}

// Append dependency
implementation("com.icerockdev.service:fcm-push-service:2.1.2")

Koin configure

include dependency

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<String>): Int {
                // remove wrong tokens here
                return 0
            }
        }
    )
}

class Container : KoinComponent {
    val pushService: PushService by inject()
}
// application.conf
fcm {
    googleServiceAccountJson = ${GOOGLE_SERVICE_ACCOUNT_JSON}
}

Send data example

pushService.sendAsync(
    payLoad = FCMPayLoad(
        dataObject = data,
        notificationObject = notification,
        tokenList = tokens
    )
)

Send data with an example of receiving a response

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.

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.