SystemResource

service in module d7-services.resources.system

Methods

• connect()

  Returns the details of currently logged in user.

  Method: POST Url: http://drupal_instance/api_endpoint/system/connect

  Returns

  Promise

  Object with session id, session name and a user object.

  Example

  performing a system connect request and handling data in promise callback

  angular
   .module('myModule', ['d7-services.resources.system'])
   .config(function (SystemResource) {
     SystemResource.connect()
       .then(
         function(confirmData) {...},
         function(failData) {...}
       );
  }
  

  performing a system connect request and handling data in event callback

  angular
   .module('myModule', ['d7-services.resources.system'])
   .config(function ($scope, SystemResource, SystemChannel) {
     SystemResource.connect();
     //subscribe to confirm event
     SystemChannel.subConnectConfirmed($scope, function(confirmData) {...});
     //subscribe to fail event
     SystemChannel.subConnectFailed($scope, function(failData) {...});
  });
  

• del_variable(data)

  Unsets a persistent variable. Case-sensitivity of the variable_* functions depends on the database collation used. To avoid problems, always use lower case for persistent variable names.

  Method: POST Url: http://drupal_instance/api_endpoint/system/del_variable

  Parameters

  Param	Type	Details
  data	Object	The requests data
  data.name	String	The name of the variable to undefine, required:true, source:post body

  Returns

  Promise

  True if successful false if not

  Example

  performing a system del_variable request and handling data in promise callback

  angular
   .module('myModule', ['d7-services.resources.system'])
   .config(function (SystemResource) {
     SystemResource.del_variable({})
       .then(
         function(confirmData) {...},
         function(failData) {...}
       );
  }
  

  performing a system del_variable request and handling data in event callback

  angular
   .module('myModule', ['d7-services.resources.system'])
   .config(function ($scope, SystemResource, SystemChannel) {
     SystemResource.del_variable({});
  
     //subscribe to confirm event
     SystemChannel.subDelVariableConfirmed($scope, function(confirmData) {...});
     //subscribe to fail event
     SystemChannel.subDelVariableFailed($scope, function(failData) {...});
  });
  

• get_variable(data)

  Returns a persistent variable. Case-sensitivity of the variable_* functions depends on the database collation used. To avoid problems, always use lower case for persistent variable names.

  Method: POST Url: http://drupal_instance/api_endpoint/system/get_variable

  Parameters

  Param	Type	Details
  data	Object	The requests data
  data.name	String	The name of the variable to return, required:true, source:post body
  data._default	String	The default value to use if this variable has never been set, required:false, source:post body

  Returns

  Promise

  Object with session id, session name and a user object.

  Example

  performing a system get_variable request and handling data in promise callback

  angular
   .module('myModule', ['d7-services.resources.system'])
   .config(function (SystemResource) {
     SystemResource.get_variable()
       .then(
         function(confirmData) {...},
         function(failData) {...}
       );
  }
  

  performing a system get_variable request and handling data in event callback

  angular
   .module('myModule', ['d7-services.resources.system'])
   .config(function ($scope, SystemResource, SystemChannel) {
     SystemResource.get_variable();
  
     //subscribe to confirm event
     SystemChannel.subGetVariableConfirmed($scope, function(confirmData) {...});
     //subscribe to fail event
     SystemChannel.subGetVariableFailed($scope, function(failData) {...});
  });
  

• set_variable(data)

  Sets a persistent variable. Case-sensitivity of the variable_* functions depends on the database collation used. To avoid problems, always use lower case for persistent variable names.

  The data object for this request looks something like this: { name : 'my_variable_name' }

  Method: POST Url: http://drupal_instance/api_endpoint/system/set_variable

  Parameters

  Param	Type	Details
  data	Object	The requests data
  data.name	String	The name of the variable to set, required:true, source:post body
  data.value	String	The value to set. This can be any PHP data type; these functions take care of serialization as necessary, required:true, source:post body

  Returns

  Promise

  True if successful false if not

  Example

  performing a system set_variable request and handling data in promise callback

  angular
   .module('myModule', ['d7-services.resources.system'])
   .config(function (SystemResource) {
     SystemResource.set_variable()
       .then(
         function(confirmData) {...},
         function(failData) {...}
       );
  }
  

  performing a system set_variable request and handling data in event callback

  angular
   .module('myModule', ['d7-services.resources.system'])
   .config(function ($scope, SystemResource, SystemChannel) {
     SystemResource.set_variable({});
  
     //subscribe to confirm event
     SystemChannel.subSetVariableConfirmed($scope, function(confirmData) {...});
     //subscribe to fail event
     SystemChannel.subSetVariableFailed($scope, function(failData) {...});
  });