OneSignal Android SDK 使用教程

OneSignal Android SDK 使用教程

OneSignal-Android-SDK OneSignal is a free push notification service for mobile apps. This plugin makes it easy to integrate your native Android or Amazon app with OneSignal. https://onesignal.com 项目地址: https://gitcode.com/gh_mirrors/on/OneSignal-Android-SDK

1. 项目的目录结构及介绍

OneSignal Android SDK 的目录结构如下：

OneSignal-Android-SDK/
├── Examples/
│   └── OneSignalDemo/
├── OneSignalSDK/
├── script/
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── MIGRATION_GUIDE.md
├── README.md
├── issue_template.md

目录结构介绍

• Examples/: 包含示例项目 OneSignalDemo，展示了如何集成 OneSignal SDK。
• OneSignalSDK/: 包含 OneSignal SDK 的核心代码。
• script/: 包含一些脚本文件，可能用于自动化任务。
• .gitignore: Git 忽略文件配置。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• MIGRATION_GUIDE.md: 迁移指南，帮助用户从旧版本迁移到新版本。
• README.md: 项目的主文档，包含基本介绍和使用说明。
• issue_template.md: GitHub Issue 模板。

2. 项目的启动文件介绍

OneSignal Android SDK 没有明确的“启动文件”，因为它是一个库项目，需要集成到你的 Android 应用中。你可以参考 Examples/OneSignalDemo 中的示例项目来了解如何启动和使用 OneSignal SDK。

示例项目启动文件

在 Examples/OneSignalDemo 中，主要的启动文件是 MainActivity.java 或 MainActivity.kt，具体取决于你使用的编程语言。这个文件通常包含初始化 OneSignal SDK 的代码。

// MainActivity.java
import com.onesignal.OneSignal;

public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // 初始化 OneSignal
        OneSignal.initWithContext(this);
        OneSignal.setAppId("YOUR_ONESIGNAL_APP_ID");
    }
}

3. 项目的配置文件介绍

build.gradle

在集成 OneSignal SDK 时，你需要在你的应用模块的 build.gradle 文件中添加依赖项：

dependencies {
    implementation 'com.onesignal:OneSignal:4.0.0'
}

AndroidManifest.xml

你还需要在 AndroidManifest.xml 中添加必要的权限和配置：

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.yourapp">

    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        
        <!-- OneSignal 配置 -->
        <meta-data android:name="com.onesignal.NotificationOpened.DEFAULT" android:value="DISABLE" />
        <meta-data android:name="com.onesignal.NotificationReceived.DEFAULT" android:value="DISABLE" />

        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

OneSignal.init()

在代码中，你需要初始化 OneSignal SDK：

OneSignal.initWithContext(this);
OneSignal.setAppId("YOUR_ONESIGNAL_APP_ID");

通过以上步骤，你可以成功集成 OneSignal Android SDK 并开始使用推送通知功能。

OneSignal-Android-SDK OneSignal is a free push notification service for mobile apps. This plugin makes it easy to integrate your native Android or Amazon app with OneSignal. https://onesignal.com 项目地址: https://gitcode.com/gh_mirrors/on/OneSignal-Android-SDK