Package cn.jpush.api.admin

Class AdminClient

  • public class AdminClient
extends java.lang.Object
    Admin APIs https://docs.jiguang.cn/jpush/server/push/rest_api_admin_api_v1/

    • Constructor Summary

      Constructors 
      Constructor Description
      AdminClient​(java.lang.String appKey, java.lang.String masterSecret)
      Create a Push Client.
      AdminClient​(java.lang.String appKey, java.lang.String masterSecret, cn.jiguang.common.connection.HttpProxy proxy)  
      AdminClient​(java.lang.String appKey, java.lang.String masterSecret, cn.jiguang.common.connection.HttpProxy proxy, JPushConfig conf)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      CreateAppResult createApp​(java.lang.String appName, java.lang.String packageName, java.lang.String groupName)
      Create an app under developer account
      AppResult deleteApp​(java.lang.String appKey)
      Delete app by app key
      void setHttpClient​(cn.jiguang.common.connection.IHttpClient client)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AdminClient

        public AdminClient​(java.lang.String appKey,
                   java.lang.String masterSecret)
        Create a Push Client.
        Parameters:
        appKey - The KEY of one application on JPush.
        masterSecret - API access secret of the appKey.

      • AdminClient

        public AdminClient​(java.lang.String appKey,
                   java.lang.String masterSecret,
                   cn.jiguang.common.connection.HttpProxy proxy)

      • AdminClient

        public AdminClient​(java.lang.String appKey,
                   java.lang.String masterSecret,
                   cn.jiguang.common.connection.HttpProxy proxy,
                   JPushConfig conf)

    • Method Detail

      • setHttpClient

        public void setHttpClient​(cn.jiguang.common.connection.IHttpClient client)

      • createApp

        public CreateAppResult createApp​(java.lang.String appName,
                                 java.lang.String packageName,
                                 java.lang.String groupName)
                          throws cn.jiguang.common.resp.APIConnectionException,
                                 cn.jiguang.common.resp.APIRequestException
        Create an app under developer account
        Parameters:
        appName - app name
        packageName - android package name
        groupName - developer app group name
        Returns:
        CreateAppResult
        Throws:
        cn.jiguang.common.resp.APIConnectionException - connect exception
        cn.jiguang.common.resp.APIRequestException - request exception

      • deleteApp

        public AppResult deleteApp​(java.lang.String appKey)
                    throws cn.jiguang.common.resp.APIConnectionException,
                           cn.jiguang.common.resp.APIRequestException
        Delete app by app key
        Parameters:
        appKey - app key
        Returns:
        AppResult
        Throws:
        cn.jiguang.common.resp.APIConnectionException - connect exception
        cn.jiguang.common.resp.APIRequestException - request exception