Trigger Reference of GS2-Friend Script

Reference of event triggers that call extended scripts

Trigger

updateProfile

profile is updated

Synchronous Execution Script

Script and profile is updated are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
profile	Profile	Profile
oldProfile	Profile	Old Profile
publicProfile	string	New Public profile
followerProfile	string	New Profile for followers
friendProfile	string	New Profile for friends

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow profile update

Implementation Example

namespace = args.namespace
profile = args.profile
oldProfile = args.oldProfile
publicProfile = args.publicProfile
followerProfile = args.followerProfile
friendProfile = args.friendProfile

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the profile is updated is executed.

Request

	Type	Description
namespace	Namespace	Namespace
oldProfile	Profile	Profile before update
profile	Profile	Profile after update

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

namespace = args.namespace
oldProfile = args.oldProfile
profile = args.profile

result = {
}

follow

follow-up

Synchronous Execution Script

Script and follow-up are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
followUser	FollowUser	Follow Information

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow follow

Implementation Example

namespace = args.namespace
followUser = args.followUser

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the follow-up is executed.

Request

	Type	Description
namespace	Namespace	Namespace
followUser	FollowUser	Follow Information

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

namespace = args.namespace
followUser = args.followUser

result = {
}

unfollow

unfollowing

Synchronous Execution Script

Script and unfollowing are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
followUser	FollowUser	Follow Information

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow Unfollow

Implementation Example

namespace = args.namespace
followUser = args.followUser

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the unfollowing is executed.

Request

	Type	Description
namespace	Namespace	Namespace
followUser	FollowUser	Follow Information

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

namespace = args.namespace
followUser = args.followUser

result = {
}

deleteFriend

a friend is deleted

Synchronous Execution Script

Script and a friend is deleted are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
userId	string	User ID
friendUser	FriendUser	Friend

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow Delete Friend

Implementation Example

namespace = args.namespace
userId = args.userId
friendUser = args.friendUser

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the a friend is deleted is executed.

Request

	Type	Description
namespace	Namespace	Namespace
userId	string	User ID
friendUser	FriendUser	Friend

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

namespace = args.namespace
userId = args.userId
friendUser = args.friendUser

result = {
}

sendRequest

Issue a friend request

Synchronous Execution Script

Script and Issue a friend request are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow friend requests to be issued

Implementation Example

namespace = args.namespace
friendRequest = args.friendRequest

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the Issue a friend request is executed.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

namespace = args.namespace
friendRequest = args.friendRequest

result = {
}

cancelRequest

cancel a friend request

Synchronous Execution Script

Script and cancel a friend request are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow cancellation of friend request

Implementation Example

namespace = args.namespace
friendRequest = args.friendRequest

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the cancel a friend request is executed.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

namespace = args.namespace
friendRequest = args.friendRequest

result = {
}

acceptRequest

a friend request is accepted

Synchronous Execution Script

Script and a friend request is accepted are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Accept friend request Allow

Implementation Example

namespace = args.namespace
friendRequest = args.friendRequest

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the a friend request is accepted is executed.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

namespace = args.namespace
friendRequest = args.friendRequest

result = {
}

rejectRequest

a friend request is rejected

Synchronous Execution Script

Script and a friend request is rejected are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow rejecting friend requests

Implementation Example

namespace = args.namespace
friendRequest = args.friendRequest

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the a friend request is rejected is executed.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

namespace = args.namespace
friendRequest = args.friendRequest

result = {
}