GS2-Friend

Reference for event triggers that call GS2-Script

GS2-Script Reference

Trigger

updateProfile

updateProfile

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

result = {
  permit=permit
}

Event trigger to call GS2-Script before profile is updated.

Request

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

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow profile update

updateProfileDone

updateProfileDone

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

result = {
}

GS2-Script called after profile is updated.

Request

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

Result

	Type	Require	Default	Limitation	Description

follow

follow

namespace = args.namespace
followUser = args.followUser

result = {
  permit=permit
}

Event trigger to call GS2-Script before follow-up.

Request

	Type	Description
namespace	Namespace	Namespace
followUser	FollowUser	Follow Information

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow follow

followDone

followDone

namespace = args.namespace
followUser = args.followUser

result = {
}

GS2-Script called after follow-up.

Request

	Type	Description
namespace	Namespace	Namespace
followUser	FollowUser	Follow Information

Result

	Type	Require	Default	Limitation	Description

unfollow

unfollow

namespace = args.namespace
followUser = args.followUser

result = {
  permit=permit
}

Event trigger to call GS2-Script before unfollowing.

Request

	Type	Description
namespace	Namespace	Namespace
followUser	FollowUser	Follow Information

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow Unfollow

unfollowDone

unfollowDone

namespace = args.namespace
followUser = args.followUser

result = {
}

GS2-Script called after unfollowing.

Request

	Type	Description
namespace	Namespace	Namespace
followUser	FollowUser	Follow Information

Result

	Type	Require	Default	Limitation	Description

deleteFriend

deleteFriend

namespace = args.namespace
friendUser = args.friendUser

result = {
  permit=permit
}

Event trigger to call GS2-Script before a friend is deleted.

Request

	Type	Description
namespace	Namespace	Namespace
friendUser	FriendUser	Friend

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow Delete Friend

deleteFriendDone

deleteFriendDone

namespace = args.namespace
friendUser = args.friendUser

result = {
}

GS2-Script called after a friend is deleted.

Request

	Type	Description
namespace	Namespace	Namespace
friendUser	FriendUser	Friend

Result

	Type	Require	Default	Limitation	Description

sendRequest

sendRequest

namespace = args.namespace
friendRequest = args.friendRequest

result = {
  permit=permit
}

Event trigger to call GS2-Script before Issue a friend request.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow friend requests to be issued

sendRequestDone

sendRequestDone

namespace = args.namespace
friendRequest = args.friendRequest

result = {
}

GS2-Script called after Issue a friend request.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Require	Default	Limitation	Description

cancelRequest

cancelRequest

namespace = args.namespace
friendRequest = args.friendRequest

result = {
  permit=permit
}

Event trigger to call GS2-Script before cancel a friend request.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow cancellation of friend request

cancelRequestDone

cancelRequestDone

namespace = args.namespace
friendRequest = args.friendRequest

result = {
}

GS2-Script called after cancel a friend request.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Require	Default	Limitation	Description

acceptRequest

acceptRequest

namespace = args.namespace
friendRequest = args.friendRequest

result = {
  permit=permit
}

Event trigger to call GS2-Script before a friend request is accepted.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Accept friend request Allow

acceptRequestDone

acceptRequestDone

namespace = args.namespace
friendRequest = args.friendRequest

result = {
}

GS2-Script called after a friend request is accepted.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Require	Default	Limitation	Description

rejectRequest

rejectRequest

namespace = args.namespace
friendRequest = args.friendRequest

result = {
  permit=permit
}

Event trigger to call GS2-Script before a friend request is rejected.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow or deny friend request

rejectRequestDone

rejectRequestDone

namespace = args.namespace
friendRequest = args.friendRequest

result = {
}

GS2-Script called after a friend request is rejected.

Request

	Type	Description
namespace	Namespace	Namespace
friendRequest	FriendRequest	Friend Request

Result

	Type	Require	Default	Limitation	Description