Skip to content
GitLab
Commit 529b3d66 authored by Naylin's avatar Naylin Committed by Alexander Salas Bastidas
Browse files

docs(*): fix typos in the tag of the params

parent c1e4b6ee
Hide whitespace changes
Inline Side-by-side
glpi/src/main/java/org/glpi/api/GLPI.java
View file @ 529b3d66
......@@ -70,7 +70,7 @@ public class GLPI extends ServiceGenerator {
/**
* Request a session token to uses other api endpoints.
* @param userToken defined in User Preference (See 'Remote access key' on GLPI)
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void initSessionByUserToken(String userToken, final InitSessionCallback callback) {
initSessionByUserToken(null, userToken, callback);
......@@ -80,7 +80,7 @@ public class GLPI extends ServiceGenerator {
* Request a session token to uses other api endpoints.
* @param appToken authorization string provided by the GLPI api configuration. [Optional]
* @param userToken defined in User Preference (See 'Remote access key' on GLPI)
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void initSessionByUserToken(String appToken, String userToken, final InitSessionCallback callback) {
......@@ -140,7 +140,7 @@ public class GLPI extends ServiceGenerator {
* Request a session token to uses other api endpoints. with a couple login & password: 2 parameters to login with user authentication
* @param user valid user on GLPI
* @param password valid password on GLPI
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void initSessionByCredentials(String user, String password, final InitSessionCallback callback) {
initSessionByCredentials(null, user, password, callback);
......@@ -151,7 +151,7 @@ public class GLPI extends ServiceGenerator {
* @param appToken authorization string provided by the GLPI api configuration. [Optional]
* @param user valid user on GLPI
* @param password valid password on GLPI
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void initSessionByCredentials(String appToken, String user, String password, final InitSessionCallback callback) {
......@@ -206,7 +206,7 @@ public class GLPI extends ServiceGenerator {
/**
* Return all the profiles associated to logged user.
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void getMyProfiles(final JsonObjectCallback callback) {
......@@ -236,7 +236,7 @@ public class GLPI extends ServiceGenerator {
/**
* Return the current active profile.
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void getActiveProfile(final JsonObjectCallback callback) {
......@@ -266,7 +266,7 @@ public class GLPI extends ServiceGenerator {
/**
* Return all the possible entities of the current logged user (and for current active profile).
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void getMyEntities(final JsonObjectCallback callback) {
......@@ -296,7 +296,7 @@ public class GLPI extends ServiceGenerator {
/**
* Return active entities of current logged user.
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void getActiveEntities(final JsonObjectCallback callback) {
......@@ -326,7 +326,7 @@ public class GLPI extends ServiceGenerator {
/**
* Return the current php $_SESSION.
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void getFullSession(final JsonObjectCallback callback) {
......@@ -356,7 +356,7 @@ public class GLPI extends ServiceGenerator {
/**
* Return the current $CFG_GLPI.
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void getGlpiConfig(final JsonObjectCallback callback) {
......@@ -386,7 +386,7 @@ public class GLPI extends ServiceGenerator {
/**
* Destroy a session identified by a session token.
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void killSession(final VoidCallback callback) {
......@@ -418,8 +418,8 @@ public class GLPI extends ServiceGenerator {
/**
* Return a collection of rows of the itemtype.
* @param itemType This are the item type available on GLPI
* @param callback here your are going to get the asynchronous response
* @param itemType These are the item type available on GLPI
* @param callback here you are going to get the asynchronous response
*/
public void getAllItems(itemType itemType, final JsonArrayCallback callback) {
getAllItems(new GetAllItemQuery(GLPI.this.context), itemType, callback);
......@@ -427,9 +427,9 @@ public class GLPI extends ServiceGenerator {
/**
* Return a collection of rows of the itemtype.
* @param options this are the parameters of this endpoint for example expand_dropdowns or get_hateoas
* @param itemType This are the item type available on GLPI
* @param callback here your are going to get the asynchronous response
* @param options These are the parameters of this endpoint for example expand_dropdowns or get_hateoas
* @param itemType These are the item type available on GLPI
* @param callback here you are going to get the asynchronous response
*/
public void getAllItems(GetAllItemQuery options, itemType itemType, final JsonArrayCallback callback) {
......@@ -459,9 +459,9 @@ public class GLPI extends ServiceGenerator {
/**
* Return the instance fields of itemtype identified by id.
* @param itemType This are the item type available on GLPI
* @param itemType These are the item type available on GLPI
* @param id unique identifier of the itemtype
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void getItem(itemType itemType, String id, final JsonObjectCallback callback) {
getItem(new GetAnItemQuery(), itemType, id, callback);
......@@ -469,9 +469,9 @@ public class GLPI extends ServiceGenerator {
/**
* Return the instance fields of itemtype identified by id.
* @param itemType This are the item type available on GLPI
* @param itemType These are the item type available on GLPI
* @param id unique identifier of the itemtype
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void getItem(String itemType, String id, final JsonObjectCallback callback) {
getItem(new GetAnItemQuery(), itemType, id, callback);
......@@ -479,10 +479,10 @@ public class GLPI extends ServiceGenerator {
/**
* Return the instance fields of itemtype identified by id.
* @param options this are the parameters of this endpoint for example expand_dropdowns or get_hateoas
* @param itemType This are the item type available on GLPI
* @param options These are the parameters of this endpoint for example expand_dropdowns or get_hateoas
* @param itemType These are the item type available on GLPI
* @param id unique identifier of the itemtype
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void getItem(GetAnItemQuery options, itemType itemType, String id, final JsonObjectCallback callback) {
getItem(options, itemType.name(), id, callback);
......@@ -490,10 +490,10 @@ public class GLPI extends ServiceGenerator {
/**
* Return the instance fields of itemtype identified by id.
* @param options this are the parameters of this endpoint for example expand_dropdowns or get_hateoas
* @param itemType This are the item type available on GLPI
* @param options These are the parameters of this endpoint for example expand_dropdowns or get_hateoas
* @param itemType These are the item type available on GLPI
* @param id unique identifier of the itemtype
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void getItem(GetAnItemQuery options, String itemType, String id, final JsonObjectCallback callback) {
......@@ -523,10 +523,10 @@ public class GLPI extends ServiceGenerator {
/**
* Return a collection of rows of the sub_itemtype for the identified item.
* @param itemType This are the item type available on GLPI
* @param itemType These are the item type available on GLPI
* @param id unique identifier of the parent itemtype
* @param subItemType This are the item type available on GLPI
* @param callback here your are going to get the asynchronous response
* @param subItemType These are the item type available on GLPI
* @param callback here you are going to get the asynchronous response
*/
public void getSubItems(String itemType, String id, String subItemType, final JsonObjectCallback callback) {
getSubItems(new GetSubItemQuery(GLPI.this.context), itemType, id, subItemType, callback);
......@@ -534,10 +534,10 @@ public class GLPI extends ServiceGenerator {
/**
* Return a collection of rows of the sub_itemtype for the identified item.
* @param itemType This are the item type available on GLPI
* @param itemType These are the item type available on GLPI
* @param id unique identifier of the parent itemtype
* @param subItemType This are the item type available on GLPI
* @param callback here your are going to get the asynchronous response
* @param subItemType These are the item type available on GLPI
* @param callback here you are going to get the asynchronous response
*/
public void getSubItems(itemType itemType, String id, itemType subItemType, final JsonObjectCallback callback) {
getSubItems(new GetSubItemQuery(GLPI.this.context), itemType, id, subItemType, callback);
......@@ -545,10 +545,10 @@ public class GLPI extends ServiceGenerator {
/**
* Return a collection of rows of the sub_itemtype for the identified item.
* @param itemType This are the item type available on GLPI
* @param itemType These are the item type available on GLPI
* @param id unique identifier of the parent itemtype
* @param subItemType This are the item type available on GLPI
* @param callback here your are going to get the asynchronous response
* @param subItemType These are the item type available on GLPI
* @param callback here you are going to get the asynchronous response
*/
public void getSubItems(GetSubItemQuery options, itemType itemType, String id, itemType subItemType, final JsonObjectCallback callback) {
getSubItems(options, itemType.name(), id, subItemType.name(), callback);
......@@ -556,11 +556,11 @@ public class GLPI extends ServiceGenerator {
/**
* Return a collection of rows of the sub_itemtype for the identified item.
* @param options this are the parameters of this endpoint for example expand_dropdowns or get_hateoas
* @param itemType This are the item type available on GLPI
* @param options These are the parameters of this endpoint for example expand_dropdowns or get_hateoas
* @param itemType These are the item type available on GLPI
* @param id unique identifier of the parent itemtype
* @param subItemType This are the item type available on GLPI
* @param callback here your are going to get the asynchronous response
* @param subItemType These are the item type available on GLPI
* @param callback here you are going to get the asynchronous response
*/
public void getSubItems(GetSubItemQuery options, String itemType, String id, String subItemType, final JsonObjectCallback callback) {
......@@ -591,7 +591,7 @@ public class GLPI extends ServiceGenerator {
/**
* Change active profile to the profiles_id one. See getMyProfiles endpoint for possible profiles.
* @param profilesId (default 'all') ID of the new active profile.
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void changeActiveProfile(String profilesId, final VoidCallback callback) {
......@@ -625,7 +625,7 @@ public class GLPI extends ServiceGenerator {
* Change active entity to the entities_id one. See getMyEntities endpoint for possible entities.
* @param entitiesId (default 'all') ID of the new active entity ("all" => load all possible entities).
* @param is_recursive (default false) Also display sub entities of the active entity.
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void changeActiveEntities(String entitiesId, Boolean is_recursive, final VoidCallback callback) {
......@@ -657,9 +657,9 @@ public class GLPI extends ServiceGenerator {
/**
* Add an object (or multiple objects) into GLPI.
* @param itemType This are the item type available on GLPI
* @param itemType These are the item type available on GLPI
* @param payload input: an object with fields of itemtype to be inserted. You can add several items in one action by passing an array of objects.
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void addItems(itemType itemType, Object payload, final JsonArrayCallback callback) {
......@@ -689,10 +689,10 @@ public class GLPI extends ServiceGenerator {
/**
* Update an object (or multiple objects) existing in GLPI.
* @param itemType This are the item type available on GLPI
* @param itemType These are the item type available on GLPI
* @param id the unique identifier of the itemtype
* @param payload Array of objects with fields of itemtype to be updated.
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void updateItems(itemType itemType, String id, Object payload, final JsonArrayCallback callback) {
......@@ -722,9 +722,9 @@ public class GLPI extends ServiceGenerator {
/**
* Delete an object existing in GLPI.
* @param itemType This are the item type available on GLPI
* @param itemType These are the item type available on GLPI
* @param id unique identifier of the itemtype
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void deleteItems(itemType itemType, String id, final JsonArrayCallback callback) {
......@@ -754,9 +754,9 @@ public class GLPI extends ServiceGenerator {
/**
* Delete multiples objects existing in GLPI.
* @param itemType This are the item type available on GLPI
* @param itemType These are the item type available on GLPI
* @param payload Array of id who need to be deleted
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void deleteItems(itemType itemType, Object payload, final JsonArrayCallback callback) {
......@@ -787,7 +787,7 @@ public class GLPI extends ServiceGenerator {
/**
* This endpoint allows to request password reset
* @param email email address of the user to recover
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void recoveryPassword(String email, final VoidCallback callback) {
......@@ -822,7 +822,7 @@ public class GLPI extends ServiceGenerator {
* @param email email address of the user to recover
* @param token reset token
* @param newPassword the new password for the user
* @param callback here your are going to get the asynchronous response
* @param callback here you are going to get the asynchronous response
*/
public void resetPassword(String email, String token, String newPassword, final VoidCallback callback) {
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment