iOS Module SDK
0.97
Tools for building CampusLife modules
|
#import <D2LModule.h>
Public Member Functions | |
(id) | - initWithAssistant: |
(UIViewController *) | - getViewController |
(void) | - moduleWillOpenFirstTime |
(void) | - moduleWillOpen |
(void) | - moduleWillClose |
(void) | - moduleWillSuspend |
(void) | - moduleWillResume |
(void) | - applicationWillSuspend |
(void) | - applicationWillResume |
(void) | - applicationWillTerminate |
(void) | - applicationDidBecomeActive |
(void) | - applicationWillResignActive |
(void) | - takeScreenshots: |
Your module must provide a class implementing this protocol. An instance of that class is created for each time your module is included in the host application. Instances of your module are specialized through the configuration parameters exposed through the D2LModuleAssistant object provided when the instance is initialized.
- (void) applicationDidBecomeActive | [optional] |
This method is called when the host application becomes active, whether or not your module is currently open.
Analogous to the application delegate's applicationDidBecomeActive method.
- (void) applicationWillResignActive | [optional] |
This method is called when the host application is to resign the active state, whether or not your module is currently open.
Analogous to the application delegate's applicationWillResignActive method.
- (void) applicationWillResume | [optional] |
This method is called when the host application resumes, whether or not your module is currently open.
Analogous to the application delegate's applicationWillEnterForeground method.
- (void) applicationWillSuspend | [optional] |
This method is called when the host application is suspended, whether or not your module is currently open.
Analogous to the application delegate's applicationDidEnterBackground method.
- (void) applicationWillTerminate | [optional] |
This method is called when the host application terminates, whether or not your module is currently open.
Analogous to the application delegate's applicationWillTerminate method.
- (UIViewController *) getViewController | [optional] |
Returns the root view controller of your module. When your module is opened, the view controller object returned by this method will be set as the root view controller of the application window.
- (id) initWithAssistant: | (id< D2LModuleAssistant >) | assistant | [required] |
Initializes the object.
assistant | - An object providing information and services specific to this module instance. You should retain this object to access its services later. |
- (void) moduleWillClose | [optional] |
This method is called when your module is closed.
- (void) moduleWillOpen | [optional] |
This method is called each time the user opens your module, before retrieving and displaying the root view controller.
- (void) moduleWillOpenFirstTime | [optional] |
This method is called the first time the user opens the module after the application has been launched. (If the user closes the host application, then reopens it and launches the module, this method will be called again.)
- (void) moduleWillResume | [optional] |
This method is called when the host application resumes directly into your module (from having suspended the app while the module was open).
- (void) moduleWillSuspend | [optional] |
This method is called when the host application is suspended while your module is currently open.
- (void) takeScreenshots: | (id< D2LModuleScreenshotAssistant >) | screenshotAssistant | [optional] |
AppBuilder has a process to automatically generate screenshots of a Campus Life app and its modules. By default, a single picture of a module is taken a few seconds after it launches. To manually control how screenshots are taken of your module, implement this method. When called, your module should begin the- process of automatically generating screenshots. When finished, you should call the appropriate method of the screenshot assistant object.
If this method is implemented but no screenshot is taken for an extended period of time, the screenshotting process for this module will be aborted.
screenshotAssistant | - a helper object with methods to take screenshots and notify when the process is complete. |