Class Apkup

Apkup constructor

import { Apkup } from 'apkup'

const auth = require('./auth.json')
const apkup = new Apkup(auth)

Hierarchy

Apkup

Index

Constructors

constructor

Properties

client

Methods

Constructors

constructor

new Apkup(auth: IAuthParams): Apkup

- Defined in index.ts:35
Parameters
- auth: IAuthParams
  
  Object with Authentication information.
Returns Apkup

Properties

Private client

client: JWT

Methods

promote

promote(promoteParams: IPromoteParams, apk?: string | string[], editParams?: IEditParams): Promise<IEditResponse>

- Defined in index.ts:109
Promote an APK from one track to another.

Parameters
- promoteParams: IPromoteParams
  
  Information related to the promotion.
- Optional apk: string | string[]
  
  The path to the APK.
- Optional editParams: IEditParams
  The package name and version code of the app.
```
// promote based on an APK
await apkup.promote(
  {
    track: 'alpha'
  },
  './android-debug.apk'
)

// promote based on package name and version code
await apkup.promote(
  {
    track: 'alpha'
  },
  {
    packageName: 'io.event1.shared',
    versionCode: 137
 }
)
```
Returns Promise<IEditResponse>

upload

upload(apk: string | string[], uploadParams?: IUploadParams): Promise<IEditResponse>

- Defined in index.ts:66
Upload an APK to the Google Play Developer Console.

Parameters
- apk: string | string[]
  
  The path to the APK.
- Optional uploadParams: IUploadParams
  
  The params object will add additional information to this release.
Returns Promise<IEditResponse>
An object with the response data.
```
const upload = await apkup.upload('./android-debug.apk', {
  track: 'beta',
  releaseNotes: [
    {
      language: 'en-US',
      text: 'Minor bug fixes...'
    }
  ]
})
```

Generated using TypeDoc