---

Classes

• _global_
• Kii
• KiiACL
• KiiACLEntry
• KiiAnonymousUser
• KiiAnyAuthenticatedUser
• KiiAppAdminContext
• KiiBucket
• KiiClause
• KiiErrorParser
• KiiGeoPoint
• KiiGroup
• KiiObject
• KiiPushInstallation
• KiiPushMessageBuilder
• KiiPushSubscription
• KiiQuery
• KiiServerCodeEntry
• KiiServerCodeExecResult
• KiiSocialConnect
• KiiThing
• KiiThingContext
• KiiThingQuery
• KiiThingQueryResult
• KiiTopic
• KiiUser
• KiiUserBuilder

---

Class KiiGroup

Represents a KiiGroup object
Defined in: KiiSDK.js.

Class Summary

Constructor Attributes	Constructor Name and Description
	KiiGroup()

Method Summary

Method Attributes	Method Name and Description
	addUser(member) Adds a user to the given group This method will NOT access the server immediately.
	bucketWithName(bucketName) Creates a reference to a bucket for this group The bucket will be created/accessed within this group's scope
	changeGroupName(newName, callbacks) Updates the group name on the server
	delete(callbacks) Delete the group from the server
	encryptedBucketWithName(bucketName) Creates a reference to a encrypted bucket for this group The bucket will be created/accessed within this group's scope
	getCachedOwner() Returns the owner of this group if this group holds the information of owner.
	getID() Get the ID of the current KiiGroup instance.
	getMemberList(callbacks) Gets a list of all current members of a group
	getName() The name of this group
	getOwner(callbacks) Gets the owner of the associated group This API does not return all the properties of the owner.
	getUUID()
<static>	KiiGroup.groupWithID(groupId) Instantiate KiiGroup that refers to existing group which has specified ID.
<static>	KiiGroup.groupWithName(groupName) Creates a reference to a group with the given name Note: Returned instance from this API can not operate existing KiiGroup.
<static>	KiiGroup.groupWithNameAndMembers(groupName, members) Creates a reference to a group with the given name and a list of default members Note: Returned instance from this API can not operate existing KiiGroup.
<static>	KiiGroup.groupWithURI(uri) Generate a new KiiGroup based on a given URI Note: Returned instance from this API can operate existing KiiGroup.
	listTopics(callbacks, paginationKey) Gets a list of topics in this group scope
	objectURI() Get a specifically formatted string referencing the group The group must exist in the cloud (have a valid UUID).
	refresh(callbacks) Updates the local group's data with the group data on the server The group must exist on the server.
<static>	KiiGroup.registerGroupWithID(groupID, groupName, members, callbacks) Register new group own by current user on Kii Cloud with specified ID.
	removeUser(member) Removes a user from the given group This method will NOT access the server immediately.
	save(callbacks) Saves the latest group values to the server If the group does not yet exist, it will be created.
	saveWithOwner(user, callbacks) Saves the latest group values to the server with specified owner.
	topicWithName(topicName) Instantiate topic belongs to this group.

  var user = . . .; // a KiiUser
  var group = . . .; // a KiiGroup
  group.addUser(user);
  group.save(callbacks);

Parameters:

{KiiUser} member

The user to be added to the group

---

  var group = . . .; // a KiiGroup
  var bucket = group.bucketWithName("myBucket");

Parameters:

{String} bucketName

The name of the bucket the user should create/access

Returns:

{KiiBucket} A working KiiBucket object

---

  // example to use callbacks directly
  var group = . . .; // a KiiGroup
  group.changeGroupName("myNewName", {
      success: function(theRenamedGroup) {
          // do something with the group
      },
  
      failure: function(theGroup, anErrorString) {
          // do something with the error response
      }
  });
  
  // example to use Promise
  var group = . . .; // a KiiGroup
  group.changeGroupName("myNewName").then(
      function(theRenamedGroup) {
          // do something with the group
      },
      function(error) {
          // do something with the error response
      }
  );

Parameters:

{String} newName

A String of the desired group name

{Object} callbacks Optional

An object with callback methods defined

{Method} callbacks.success

The callback method to call on a successful save request

{Method} callbacks.failure

The callback method to call on a failed save request

Returns:

{Promise} return promise object.

• fulfill callback function: function(theRenamedGroup). theRenamedGroup is KiiGroup instance.
• reject callback function: function(error). error is an Error instance.
  • error.target is the KiiGroup instance which this method was called on.
  • error.message

---

  // example to use callbacks directly
  var group = . . .; // a KiiGroup
  group.delete({
      success: function(theDeletedGroup) {
          // do something
      },
  
      failure: function(theGroup, anErrorString) {
          // do something with the error response
      }
  });
  
  // example to use Promise
  var group = . . .; // a KiiGroup
  group.delete({
      success: function(theDeletedGroup) {
      },
  
      failure: function(theGroup, anErrorString) {
      }
  }).then(
      function(theDeletedGroup) {
          // do something
      },
      function(error) {
          // do something with the error response
      }
  );

Parameters:

{Object} callbacks Optional

An object with callback methods defined

{Method} callbacks.success

The callback method to call on a successful delete request

{Method} callbacks.failure

The callback method to call on a failed delete request

Returns:

{Promise} return promise object.

• fulfill callback function: function(theDeletedGroup). theDeletedGroup is KiiGroup instance.
• reject callback function: function(error). error is an Error instance.
  • error.target is the KiiGroup instance which this method was called on.
  • error.message

---

  var group = . . .; // a KiiGroup
  var bucket = group.encryptedBucketWithName("myBucket");

Parameters:

{String} bucketName

The name of the bucket the user should create/access

Returns:

{KiiEncryptedBucket} A working KiiEncryptedBucket object

---

Returns:

{KiiUser} KiiUser who owns this group, undefined if this group doesn't hold the information of owner yet.

See:

KiiGroup#getOwner

---

Returns:

{String} Id of the group or null if the group has not saved to cloud.

---

  // example to use callbacks directly
  var group = . . .; // a KiiGroup
  group.getMemberList({
      success: function(theGroup, memberList) {
          // do something with the result
          for(var i=0; i<memberList.length; i++){
              var u = memberList[i]; // a KiiUser within the group
          }
      },
  
      failure: function(theGroup, anErrorString) {
          // do something with the error response
      }
  });
  
  // example to use Promise
  var group = . . .; // a KiiGroup
  group.getMemberList().then(
      function(params) {
          var theGroup = params[0];
          var memberlist = params[1];
          // do something with the result
          for(var i=0; i<memberList.length; i++){
              var u = memberList[i]; // a KiiUser within the group
          }
      },
      function(error) {
          // do something with the error response
      }
  );

Parameters:

{Object} callbacks Optional

An object with callback methods defined

{Method} callbacks.success

The callback method to call on a successful list request

{Method} callbacks.failure

The callback method to call on a failed list request

Returns:

{Promise} return promise object.

• fulfill callback function: function(params). params is Array instance.
  • params[0] is a KiiGroup instance which this method was called on.
  • params[1] is array of memeber KiiUser instances.
• reject callback function: function(error). error is an Error instance.
  • error.target is the KiiGroup instance which this method was called on.
  • error.message

---

Returns:

{String}

---

  // example to use callbacks directly
  var group = . . .; // a KiiGroup
  group.getOwner({
      success: function(theGroup, theOwner) {
          // do something
      },
      failure: function(theGroup, anErrorString) {
          // do something with the error response
      }
  });
  
  // example to use Promise
  var group = . . .; // a KiiGroup
  group.getOwner().then(
      function(params) {
          // do something
      },
      function(error) {
          // do something with the error response
      }
  );

Parameters:

{Object} callbacks Optional

An object with callback methods defined

{Method} callbacks.success

The callback method to call on a successful add request

{Method} callbacks.failure

The callback method to call on a failed add request

Returns:

{Promise} return promise object.

• fulfill callback function: function(params). params is Array instance.
  • params[0] is the KiiGroup instance which this method was called on.
  • params[1] is an group owner KiiUser instances.
• reject callback function: function(error). error is an Error instance.
  • error.target is the KiiGroup instance which this method was called on.
  • error.message

---

Deprecated:

Use KiiGroup.getId instead. Get the UUID of the given group, assigned by the server

Returns:

{String}

---

  var group = new KiiUser.groupWithID("__GROUP_ID__");

Parameters:

groupId

ID of the KiiGroup to instantiate.

Throws:

{InvalidArgumentException}

when passed groupID is empty or null.

Returns:

instance of KiiGroup.

---

  var group = new KiiGroup.groupWithName("myGroup");

Parameters:

{String} groupName

An application-specific group name

Returns:

{KiiGroup} A new KiiGroup reference

---

  var group = new KiiGroup.groupWithName("myGroup", members);

Parameters:

{String} groupName

An application-specific group name

{Array} members

An array of KiiUser objects to add to the group

Returns:

{KiiGroup} A new KiiGroup reference

---

  var group = new KiiGroup.groupWithURI("kiicloud://myuri");

Parameters:

{String} uri

The URI of the group to be represented

Throws:

{InvalidURIException}

If the URI given is invalid

Returns:

{KiiGroup} A new KiiGroup with its parameters filled in from the URI

---

  // example to use callbacks directly
  var group = . . .; // a KiiGroup
  group.listTopics({
      success: function(topicList, nextPaginationKey) {
          // do something with the result
          for(var i=0; i<topicList.length; i++){
              var topic = topicList[i];
          }
          if (nextPaginationKey != null) {
              group.listTopics({
                  success: function(topicList, nextPaginationKey) {...},
                  failure: function(anErrorString) {...}
              }, nextPaginationKey);
          }
      },
      failure: function(anErrorString) {
          // do something with the error response
      }
  });
  
  // example to use promise
  var group = . . .; // a KiiGroup
  group.listTopics().then(
      function(params) {
          var topicList = params[0];
          var nextPaginationKey = params[1];
          // do something with the result
          for(var i=0; i<topicList.length; i++){
              var topic = topicList[i];
          }
          if (nextPaginationKey != null) {
              group.listTopics(null, nextPaginationKey).then(
                  function(params) {...},
                  function(error) {...}
              );
          }
      },
      function(error) {
          // do something with the error response
      }
  );

Parameters:

{Object} callbacks Optional

An object with callback methods defined

{Method} callbacks.success

The callback method to call on a successful list request

{Method} callbacks.failure

The callback method to call on a failed list request

{String} paginationKey Optional

You can specify the pagination key with the nextPaginationKey passed by callbacks.success. If empty string or no string object is provided, this API regards no paginationKey specified.

Returns:

{Promise} return promise object.

• fulfill callback function: function(params). params is Array instance.
  • params[0] is array of KiiTopic instances.
  • params[1] is string of nextPaginationKey.
• reject callback function: function(error). error is an Error instance.
  • error.target is the KiiGroup instance which this method was called on.
  • error.message

---

  var group = . . .; // a KiiGroup
  var uri = group.objectURI();

Returns:

{String} A URI string based on the current group. null if a URI couldn't be generated.

---

  // example to use callbacks directly
  var group = . . .; // a KiiGroup
  group.refresh({
      success: function(theRefreshedGroup) {
          // do something with the refreshed group
      },
  
      failure: function(theGroup, anErrorString) {
          // do something with the error response
      }
  });
  
  // example to use Promise
  var group = . . .; // a KiiGroup
  group.refresh().then(
      function(theRefreshedGroup) {
          // do something with the refreshed group
      },
      function(error) {
          // do something with the error response
      }
  );

Parameters:

{Object} callbacks Optional

An object with callback methods defined

{Method} callbacks.success

The callback method to call on a successful refresh request

{Method} callbacks.failure

The callback method to call on a failed refresh request

Returns:

{Promise} return promise object.

• fulfill callback function: function(theRefreshedGroup). theRefreshedGroup is KiiGroup instance.
• reject callback function: function(error). error is an Error instance.
  • error.target is the KiiGroup instance which this method was called on.
  • error.message

---

  // example to use callbacks directly
  var members = [];
  members.push(KiiUser.userWithID("Member User Id"));
  KiiGroup.registerGroupWithID("Group ID", "Group Name", members, {
      success: function(theSavedGroup) {
          // do something with the saved group
      },
      failure: function(theGroup, anErrorString, addMembersArray, removeMembersArray) {
          // do something with the error response
      }
  });
  
  // example to use Promise
  var members = [];
  members.push(KiiUser.userWithID("Member User Id"));
  KiiGroup.registerGroupWithID("Group ID", "Group Name", members).then(
      function(theSavedGroup) {
          // do something with the saved group
      },
      function(error) {
          var theGroup = error.target;
          var anErrorString = error.message;
          var addMembersArray = error.addMembersArray;
          // do something with the error response
  });

Parameters:

{String} groupID

ID of the KiiGroup

{String} groupName

Name of the KiiGroup

{Array} members

An array of KiiUser objects to add to the group

{Object} callbacks Optional

An object with callback methods defined

{Method} callbacks.success

The callback method to call on a successful register request

{Method} callbacks.failure

The callback method to call on a failed register request

Returns:

{Promise} return promise object.

• fulfill callback function: function(theSavedGroup). theSavedGroup is KiiGroup instance.
• reject callback function: function(error). error is an Error instance.
  • error.target is the KiiGroup instance which this method was called on.
  • error.message
  • error.addMembersArray is array of KiiUser to be added as memebers of this group.
  • error.removeMembersArray is array of KiiUser to be removed from the memebers list of this group.

---

  var user = . . .; // a KiiUser
  var group = . . .; // a KiiGroup
  group.removeUser(user);
  group.save(callbacks);

Parameters:

{KiiUser} member

The user to be added to the group

---

  // example to use callbacks directly
  var group = . . .; // a KiiGroup
  group.save({
      success: function(theSavedGroup) {
          // do something with the saved group
      },
  
      failure: function(theGroup, anErrorString, addMembersArray, removeMembersArray) {
          // do something with the error response
      }
  });
  
  // example to use Promise
  var group = . . .; // a KiiGroup
  group.save().then(
      function(theSavedGroup) {
          // do something with the saved group
      },
      function(error) {
          var theGroup = error.target;
          var anErrorString = error.message;
          var addMembersArray = error.addMembersArray;
          var removeMembersArray = error.removeMembersArray;
          // do something with the error response
  });

Parameters:

{Object} callbacks Optional

An object with callback methods defined

{Method} callbacks.success

The callback method to call on a successful save request

{Method} callbacks.failure

The callback method to call on a failed save request

Returns:

{Promise} return promise object.

• fulfill callback function: function(theSavedGroup). theSavedGroup is KiiGroup instance.
• reject callback function: function(error). error is an Error instance.
  • error.target is the KiiGroup instance which this method was called on.
  • error.message
  • error.addMembersArray is array of KiiUser to be added as memebers of this group.
  • error.removeMembersArray is array of KiiUser to be removed from the memebers list of this group.

---

  // example to use callbacks directly
  var group = . . .; // a KiiGroup
  group.saveWithOwner("UserID of owner", {
      success: function(theSavedGroup) {
          // do something with the saved group
      },
  
      failure: function(theGroup, anErrorString, addMembersArray, removeMembersArray) {
          // do something with the error response
      }
  });
  
  // example to use Promise
  var group = . . .; // a KiiGroup
  group.saveWithOwner("UserID of owner").then(
      function(theSavedGroup) {
          // do something with the saved group
      },
      function(error) {
          var theGroup = error.target;
          var anErrorString = error.message;
          var addMembersArray = error.addMembersArray;
          var removeMembersArray = error.removeMembersArray;
          // do something with the error response
  });

Parameters:

{String} user

id of owner

{Object} callbacks Optional

An object with callback methods defined

{Method} callbacks.success

The callback method to call on a successful save request

{Method} callbacks.failure

The callback method to call on a failed save request

Returns:

{Promise} return promise object.

• fulfill callback function: function(theSavedGroup). theSavedGroup is KiiGroup instance.
• reject callback function: function(error). error is an Error instance.
  • error.target is the KiiGroup instance which this method was called on.
  • error.message
  • error.addMembersArray is array of KiiUser to be added as memebers of this group.
  • error.removeMembersArray is array of KiiUser to be removed from the memebers list of this group.

---

Parameters:

{String} topicName

name of the topic. Must be a not empty string.

Returns:

{KiiTopic} topic instance.

---