IAutodesk360 Class Reference
#include <IAutodesk360.h>
Class Description
Interface class for exposing methods associated with Autodesk 360.
This class can be used to get some information on the login state of the current user into Autodesk 360. This informations may be helpful for dealing with rendering in the A360 cloud as well as for using the OxygenID of the current user that may be used for Autodesk AppStore related validations.
Inheritance diagram for IAutodesk360:
Public Types | |
| enum | { em_login, em_logout, em_isloggedin, em_isloginvalid, em_getloginusername, em_getoxygenid, em_initialize } |
| Public Types inherited from BaseInterface | |
| enum | LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled } |
Public Member Functions | |
| virtual bool | Login () const =0 |
| Logs into Autodesk 360. More... | |
| virtual bool | Logout () const =0 |
| Logs out of Autodesk 360. More... | |
| virtual bool | IsLoggedIn () const =0 |
| Checks if the user is logged in into Autodesk 360. More... | |
| virtual bool | IsLoginValid () const =0 |
| Checks if the user is logged into Autodesk 360 and the login session is still valid. More... | |
| virtual const MSTR | GetLoginUserName () const =0 |
| Gets the username if the user is logged in. More... | |
| virtual MSTR | GetOxygenID () const =0 |
| Gets the OxygenID of the logged in Autodesk360 user. More... | |
| virtual bool | InitializeWebServices () const =0 |
| Initializes web-services if not previously initialized. More... | |
| Public Member Functions inherited from FPInterfaceDesc | |
| CoreExport | FPInterfaceDesc () |
| CoreExport | FPInterfaceDesc (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, ULONG flag,...) |
| CoreExport | ~FPInterfaceDesc () |
| virtual void | Init () |
| LifetimeType | LifetimeControl () |
| virtual BaseInterface * | GetInterface (Interface_ID id) |
| CoreExport void | LoadDescriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *pCD, ULONG flag,...) |
| CoreExport void | AppendFunction (int id,...) |
| Add a new function to this interface descriptor. More... | |
| CoreExport void | AppendProperty (int id,...) |
| Add a new property to this interface descriptor. More... | |
| CoreExport void | AppendEnum (int id,...) |
| Add a new enum to this interface descriptor. More... | |
| CoreExport void | SetClassDesc (ClassDesc *i_cd) |
| CoreExport va_list | check_fn (va_list ap, int id) |
| CoreExport va_list | scan_fn (va_list ap, int id, int index) |
| CoreExport va_list | check_prop (va_list ap, int id) |
| CoreExport va_list | scan_prop (va_list ap, int id, int index) |
| CoreExport va_list | check_enum (va_list ap, EnumID id) |
| CoreExport va_list | scan_enum (va_list ap, EnumID id, int index) |
| FPInterfaceDesc * | GetDesc () |
| Interface_ID | GetID () |
| CoreExport FPFunctionDef * | GetFnDef (FunctionID fid) |
| ActionTable * | GetActionTable () |
| CoreExport void | EnableActions (BOOL onOff) |
| virtual CoreExport HINSTANCE | HInstance () |
| virtual CoreExport const MCHAR * | GetRsrcString (StringResID id) |
| Public Member Functions inherited from FPInterface | |
| virtual CoreExport FPStatus | Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL) |
| virtual FPStatus | Invoke (FunctionID fid, FPParams *params) |
| virtual CoreExport FPStatus | Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL) |
| virtual FPStatus | Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL) |
| virtual CoreExport FunctionID | FindFn (const MCHAR *name) |
| virtual CoreExport BOOL | IsEnabled (FunctionID actionID) |
| virtual CoreExport BOOL | IsChecked (FunctionID actionID) |
| virtual CoreExport BOOL | IsVisible (FunctionID actionID) |
| virtual CoreExport FunctionID | GetIsEnabled (FunctionID actionID) |
| virtual CoreExport FunctionID | GetIsChecked (FunctionID actionID) |
| virtual CoreExport FunctionID | GetIsVisible (FunctionID actionID) |
| Public Member Functions inherited from BaseInterface | |
| virtual UtilExport | ~BaseInterface () |
| Destructor. More... | |
| virtual bool | RegisterNotifyCallback (InterfaceNotifyCallback *incb) |
| virtual void | UnRegisterNotifyCallback (InterfaceNotifyCallback *incb) |
| virtual BaseInterface * | AcquireInterface () |
| virtual void | ReleaseInterface () |
| virtual void | DeleteInterface () |
| virtual BaseInterface * | CloneInterface (void *remapDir=NULL) |
| Public Member Functions inherited from InterfaceServer | |
| virtual UtilExport | ~InterfaceServer () |
| Destructor. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from MaxHeapOperators | |
| static UtilExport void * | operator new (size_t size) |
| Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, const std::nothrow_t &e) |
| Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new (size_t size, const char *filename, int line) |
| New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, int block_type, const char *filename, int line) |
| New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, const char *filename, int line) |
| New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new (size_t size, unsigned long flags) |
| New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, unsigned long flags) |
| New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new[] (size_t size) |
| New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e) |
| New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new[] (size_t size, const char *filename, int line) |
| New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new[] (size_t size, int block_type, const char *filename, int line) |
| New operator used to allocate arrays of objects. More... | |
| static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line) |
| New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new[] (size_t size, unsigned long flags) |
| New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags) |
| New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void | operator delete (void *ptr) |
| Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e) |
| Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete (void *ptr, const char *filename, int line) |
| Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, int block_type, const char *filename, int line) |
| Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
| Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete (void *ptr, unsigned long flags) |
| Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags) |
| Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete[] (void *ptr) |
| Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e) |
| Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete[] (void *ptr, const char *filename, int line) |
| Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, int block_type, const char *filename, int line) |
| Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
| Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete[] (void *ptr, unsigned long flags) |
| Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags) |
| Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, void *placement_ptr) |
| Placement new operator. More... | |
| static UtilExport void | operator delete (void *ptr, void *placement_ptr) |
| Placement delete operator. More... | |
| static UtilExport void * | aligned_malloc (size_t size, size_t alignment) |
| Allocates memory on a specified alignment boundary. More... | |
| static UtilExport void * | aligned_realloc (void *ptr, size_t size, size_t alignment) |
| Reallocates memory on a specified alignment boundary. More... | |
| static UtilExport void | aligned_free (void *ptr) |
| Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More... | |
| Public Attributes inherited from FPInterfaceDesc | |
| Interface_ID | ID |
| MSTR | internal_name |
| StringResID | description |
| ClassDesc * | cd |
| USHORT | flags |
| Tab< FPFunctionDef * > | functions |
| Tab< FPPropDef * > | props |
| Tab< FPEnum * > | enumerations |
| MSPluginClass * | pc |
| Rollout * | rollout |
| ActionTable * | action_table |
| Static Public Attributes inherited from FPInterface | |
| static CoreExport FPInterfaceDesc | nullInterface |
| Protected Member Functions inherited from FPInterfaceDesc | |
| CoreExport void | load_descriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, USHORT flag, va_list ap) |
| Protected Member Functions inherited from FPInterface | |
| virtual FPStatus | _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p) |
Member Enumeration Documentation
| anonymous enum |
| Enumerator | |
|---|---|
| em_login | |
| em_logout | |
| em_isloggedin | |
| em_isloginvalid | |
| em_getloginusername | |
| em_getoxygenid | |
| em_initialize | |
Definition: IAutodesk360.h:85
Definition: IAutodesk360.h:89
Definition: IAutodesk360.h:84
Definition: IAutodesk360.h:83
Definition: IAutodesk360.h:86
Definition: IAutodesk360.h:88
Definition: IAutodesk360.h:87
Member Function Documentation
|
pure virtual |
Logs into Autodesk 360.
This function will return immediately, the login procedure gets performed in an asynchronous way.
- See also
- IsLoggedIn(), IsLoginValid(), Logout()
|
pure virtual |
Logs out of Autodesk 360.
- See also
- Login(), IsLoggedIn(), IsLoginValid()
|
pure virtual |
Checks if the user is logged in into Autodesk 360.
This function just checks if the user is logged in on this machine, but the login information might be cached and the session might not be valid any more. To Check if the session is valid, you have to call IsLoginValid().
- See also
- IsLoginValid()
|
pure virtual |
Checks if the user is logged into Autodesk 360 and the login session is still valid.
Checks if the user is logged in into and the login session has not yet expired. To Check if a user is logged in only, you may also call IsLoggedIn().
- Returns
- True if the user is logged in and the login session has not expired, false in all the other cases.
- See also
- IsLoggedIn()
|
pure virtual |
Gets the username if the user is logged in.
- Returns
- The Autodesk360 username of the logged in user, or an empty string, if the user is not logged in.
- See also
- GetOxygenID(), IsLoggedIn()
|
pure virtual |
Gets the OxygenID of the logged in Autodesk360 user.
The OxygenID can be used for Autodesk AppStore related validations.
- Returns
- The OxygenID of the logged in A360 user or an empty string, if the user is currently not logged in.
- See also
- IsLoggedIn(), IsLoginValid()
|
pure virtual |
Initializes web-services if not previously initialized.
The internal web-services get implicit initialized, so this function normally has not to be called at all, but since loading the services may be a costly operation, this call may be used to preload the needed web-services.