Skip to content

Latest commit

 

History

History
94 lines (61 loc) · 3.09 KB

admin.md

File metadata and controls

94 lines (61 loc) · 3.09 KB
Raw

Admin class for launchpy

The Admin class is the first class that you would like to instantiate in order to retrieve useful information for further usage of the launchpy module.
This class enables you to realize actions that are within administrative panel.

You can instantiate the Admin class once you have imported the information

getCompanyId

The most important method to use is the getCompanyId method that will return the company ID from your adobe IO connector.
You can access your company ID by doing the following code:

import launchpy as lp

lp.importConfigFile('myconfig.json')

admin = lp.Admin()
myCid = admin.getCompanyId()

## can be access via your variable
myCid
## or saved attribute
admin.COMPANY_ID

As you may have noted the result is automatically stored in the COMPANY_ID attribute of your instance.

getProperties

This method takes one argument (the company id) and it will return a list of property that you will be able to feed the Property class.
Following the previous example:

myProperties = admin.getProperties(myCid)

## can be access via your variable
myProperties
## or saved attribute
admin.properties

getAuditEvents

You can request Audit Events directly from the Admin instance.
These events will give you information about what has happened on your different properties so it is property agnostic.
The method takes those arguments:

  • page_size : How many result per page. (default 50 - max 100)
  • nb_page : How many page to return. (default 10)
  • type_of : event to look for.

As you can see, we can only have 10 pages of 100 results.

createProperty

It takes several arguments:

  • the company id
  • a name
  • the platform (by default it is web)
  • return_class : a Boolean if you want to return an instance of the Property class.

It returns either the instance of the Property class or the object returned by the API.

Other methods

  • updateProperty : Update a property based on the information passed in the attributes. Arguments:

  • deleteProperty : Delete a property based on the information passed in the attributes. Arguments:

    • propertyId : REQUIRED : The property ID to be deleted

Extension Packages

When creating a new property, you may want to see the possible packages that you can install. There is a method available in the core components to access the available module.

  • getExtensionsCatalogue: returns a list of the extension available for your company. Arguments:
    • availability : OPTIONAL : to filter for a specific type of extension. ("public" or "private")
    • name : OPTIONAL : to filter for a specific extension name (contains method)
    • platform : OPTIONAL : to filter for a specific platform (default "web", mobile possible)
    • save : OPTIONAL : save the results in a txt file (packages.txt). Default False.

You will need to use the name, the display name and the platform