Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProjectAPI

Hierarchy

  • ProjectAPI

Index

Methods

Static assignSigningKey

  • assignSigningKey(projectId: string, signingKeyId: string): Promise<void>
  • Assigns a singing key to the correspondent platform of a project. Next compilations will try to use the key. If there was another key assigned to the platform the new key overwrites it.

    Parameters

    • projectId: string

      ID of the project to assign the key.

    • signingKeyId: string

      ID of the signing key that you want to assign to the project.

    Returns Promise<void>

    Promise of a successful operation.

Static compile

  • compile(projectId: string): Promise<void>
  • Places a project in the compilation queue.

    Parameters

    • projectId: string

      ID of the project to compile.

    Returns Promise<void>

    Promise of a successful operation.

Static compileDevApp

  • compileDevApp(projectId: string): Promise<void>
  • Places a DevApp of a project in the compilation queue.

    Parameters

    • projectId: string

      ID of the project to compile a DevApp.

    Returns Promise<void>

    Promise of a successful operation.

Static createFromRepository

  • Create a project from a git repository to clone.

    Parameters

    • repo: IRepositoryData

      Object containing a URL of the git repo and the name of the branch to checkout (defaults to master if not set). It's used to fetch the source code for the project. Can contain a config.xml too.

    Returns Promise<Project>

    Promise of the project created.

Static createFromRepositoryUnprocessed

  • Create a project from a git repository to clone.

    Parameters

    • repo: IRepositoryData

      Object containing a URL of the git repo and the name of the branch to checkout (defaults to master if not set). It's used to fetch the source code for the project. Can contain a config.xml too.

    Returns Promise<IProjectData>

    Promise of the data of the project created.

Static createFromURL

  • createFromURL(pUrl: string): Promise<Project>
  • Create a project from an URL .

    Parameters

    • pUrl: string

      URL to fetch the source code. Can contain a config.xml file too.

    Returns Promise<Project>

    Promise of the project created.

Static createFromURLUnprocessed

  • createFromURLUnprocessed(pUrl: string): Promise<IProjectData>
  • Create a project from an URL .

    Parameters

    • pUrl: string

      URL to fetch the source code. Can contain a config.xml file too.

    Returns Promise<IProjectData>

    Promise of the data of the project created.

Static createFromZipUpload

  • createFromZipUpload(file: File): Promise<Project>
  • Create a project from a Zip file.

    Parameters

    • file: File

      Zip file containing the source code. Can contain a config.xml file too.

    Returns Promise<Project>

    Promise of the project created.

Static createFromZipUploadUnprocessed

  • createFromZipUploadUnprocessed(file: File): Promise<IProjectData>
  • Create a project from a Zip file.

    Parameters

    • file: File

      Zip file containing the source code. Can contain a config.xml file too.

    Returns Promise<IProjectData>

    Promise of the data of the project created.

Static delete

  • delete(projectId: string): Promise<void>
  • Delete a project.

    Parameters

    • projectId: string

      ID of the project to delete.

    Returns Promise<void>

    Promise of a successful operation.

Static get

  • get(projectId: string): Promise<Project>
  • Fetch the information of a project.

    Parameters

    • projectId: string

      ID of the project to fetch.

    Returns Promise<Project>

    Promise of the project fetched.

Static getConfigXml

  • getConfigXml(projectId: string): Promise<string>
  • Fetches the config.xml file of a project.

    Parameters

    • projectId: string

      ID of the project to fetch the config.xml.

    Returns Promise<string>

    Promise of the config.xml file of a project.

Static getIconBlob

  • getIconBlob(projectId: string, platform: Platform): Promise<Blob>
  • Get the icon of a project.

    Parameters

    • projectId: string

      ID of the project to get the icon.

    • platform: Platform

      Platform to get the icon. If not set the default icon will be fetched.

    Returns Promise<Blob>

    Promise of the icon of the project.

Static getSplashBlob

  • getSplashBlob(projectId: string, platform: Platform): Promise<Blob>
  • Get the splash of the project.

    Parameters

    • projectId: string

      ID of the project to get the splash.

    • platform: Platform

      Platform to get the splash. If not set the default splash will be fetched.

    Returns Promise<Blob>

    Promise of the splash of the project.

Static getUnprocessed

  • Fetch the information of a project.

    Parameters

    • projectId: string

      ID of the project to fetch.

    Returns Promise<IProjectData>

    Promise of the data of the project fetched.

Static list

  • Fetch a list containing the information of all the project.

    Returns Promise<Project[]>

    Promise of the list of all the projects.

Static listUnprocessed

  • Fetch a list containing the information of all the project.

    Returns Promise<IProjectData[]>

    Promise of the list of data of all the projects.

Static removeSigningKey

  • removeSigningKey(projectId: string, signingKeyId: string): Promise<void>
  • Removes the signing key assigned to the indicated project platform.

    Parameters

    • projectId: string

      ID of the project to remove the key.

    • signingKeyId: string

      ID of the signing key that you want to remove from the project.

    Returns Promise<void>

    Promise of a successful operation.

Static setIconBlob

  • setIconBlob(icon: File, projectId: string, platform: Platform): Promise<void>
  • Set the icon of a project.

    Parameters

    • icon: File

      Image to use as new icon. Recommended 2048x2048 PNG.

    • projectId: string

      ID of the project to set the icon.

    • platform: Platform

      Platform to set the icon. If not set the default icon will be updated.

    Returns Promise<void>

    Promise of a successful operation.

Static setSplashBlob

  • setSplashBlob(splash: File, projectId: string, platform: Platform): Promise<void>
  • Set the splash of the project.

    Parameters

    • splash: File

      Image to use as new splash. Recommended 2048x2048 PNG.

    • projectId: string

      ID of the project to set the splash.

    • platform: Platform

      Platform to set the splash. If not set the default splash will be updated.

    Returns Promise<void>

    Promise of a successful operation.

Static updateConfigXml

  • updateConfigXml(projectId: string, xml: string): Promise<Project>
  • Updates the config.xml file of a project.

    Parameters

    • projectId: string

      ID of the project to update the config.xml.

    • xml: string

      New config.xml for the project.

    Returns Promise<Project>

    Promise of the project whose config.xml was updated.

Static updateConfigXmlUnprocessed

  • updateConfigXmlUnprocessed(projectId: string, xml: string): Promise<IProjectData>
  • Updates the config.xml file of a project.

    Parameters

    • projectId: string

      ID of the project to update the config.xml.

    • xml: string

      New config.xml for the project.

    Returns Promise<IProjectData>

    Promise of the date of the project whose config.xml was updated.

Static updateRepository

  • updateRepository(projectId: string, repo: object): Promise<Project>
  • Update the source code of a project providing a git repository to clone.

    Parameters

    • projectId: string

      ID of the project to update.

    • repo: object

      Object containing a URL of the git repo and the name of the branch to checkout (defaults to master if not set). It's used to fetch the source code for the project. Can contain a config.xml too.

      • Optional branch?: string
      • url: string

    Returns Promise<Project>

    Promise of the project updated.

Static updateRepositoryUnprocessed

  • updateRepositoryUnprocessed(projectId: string, repo: object): Promise<IProjectData>
  • Update the source code of a project providing a git repository to clone.

    Parameters

    • projectId: string

      ID of the project to update.

    • repo: object

      Object containing a URL of the git repo and the name of the branch to checkout (defaults to 'master' if not set). It's used to fetch the source code for the project. Can contain a config.xml too.

      • Optional branch?: string
      • url: string

    Returns Promise<IProjectData>

    Promise of the data of the project updated.

Static updateURL

  • updateURL(projectId: string, pUrl: string): Promise<Project>
  • Update the source code of a project providing a URL to fetch it from.

    Parameters

    • projectId: string

      ID of the project to update.

    • pUrl: string

      URL to fetch the source code. Can contain a config.xml file too.

    Returns Promise<Project>

    Promise of the project updated.

Static updateURLUnprocessed

  • updateURLUnprocessed(projectId: string, pUrl: string): Promise<IProjectData>
  • Update the source code of a project providing a URL to fetch it from.

    Parameters

    • projectId: string

      ID of the project to update.

    • pUrl: string

      URL to fetch the source code. Can contain a config.xml file too.

    Returns Promise<IProjectData>

    Promise of the data of the project updated.

Static updateZip

  • updateZip(projectId: string, file: File): Promise<Project>
  • Update the source code of a project uploading a zip file.

    Parameters

    • projectId: string

      ID of the project to update.

    • file: File

      Zip file containing the source code. Can contain a config.xml file too.

    Returns Promise<Project>

    Promise of the project updated.

Static updateZipUnprocessed

  • updateZipUnprocessed(projectId: string, file: File): Promise<IProjectData>
  • Update the source code of a project uploading a zip file.

    Parameters

    • projectId: string

      ID of the project to update.

    • file: File

      Zip file containing the source code. Can contain a config.xml file too.

    Returns Promise<IProjectData>

    Promise of the data of the project updated.

Generated using TypeDoc