ListTeamChatRequest

Get a list of the messages sent to the team (by players using SendTeamChatMessageRequest).

Request Parameters

Parameter	Required	Type	Description
entryCount	No	number	The number of messages to return (default=50)
offset	No	number	The offset (nth message) to start from (default=0)
ownerId	No	string	The team owner to find, used in combination with teamType. If not supplied the current players id will be used
teamId	No	string	The teamId to find (may be null if teamType supplied)
teamType	No	string	The teamType to find, used in combination with the current player, or the player defined by ownerId

Response Parameters

A response to a list team messages request.

Parameter	Type	Description
messages	ChatMessage[]	The collection of team chat messages
scriptData	ScriptData	A JSON Map of any data added either to the Request or the Response by your Cloud Code

Nested types

ChatMessage

A message from a group chat

Parameter	Type	Description
fromId	string	The id of the player who sent this message
id	string	The id of this chat message
message	string	The text sent in this message
when	date	A date representing the time this message was sent
who	string	The displayName of the player who sent this message

ScriptData

A collection of arbitrary data that can be added to a message via a Cloud Code script.

Parameter	Type	Description
myKey	string	An arbitrary data key
myValue	JSON	An arbitrary data value.

Error Codes

Key	Value	Description
teamId\|teamType	REQUIRED	The teamId or teamType is required but not provided
authentication	NOTAUTHORIZED	The player is not authorized to perform the request

Code Samples

C#

    using GameSparks.Api;
    using GameSparks.Api.Requests;
    using GameSparks.Api.Responses;
    ...
    new ListTeamChatRequest()
        .SetEntryCount(entryCount)
        .SetOffset(offset)
        .SetOwnerId(ownerId)
        .SetTeamId(teamId)
        .SetTeamType(teamType)
        .Send((response) => {
        GSEnumerable<ListTeamChatResponse._ChatMessage> messages = response.Messages;
        GSData scriptData = response.ScriptData;
        });

ActionScript 3

    import com.gamesparks.*;
    import com.gamesparks.api.requests.*;
    import com.gamesparks.api.responses.*;
    import com.gamesparks.api.types.*;
    ...

    gs.getRequestBuilder()
        .createListTeamChatRequest()
        .setEntryCount(entryCount)
        .setOffset(offset)
        .setOwnerId(ownerId)
        .setTeamId(teamId)
        .setTeamType(teamType)
        .send(function(response:com.gamesparks.api.responses.ListTeamChatResponse):void {
        var messages:Vector.<ChatMessage> = response.getMessages(); 
        var scriptData:ScriptData = response.getScriptData(); 
        });

Objective-C

    #import "GS.h"
    #import "GSAPI.h"
    ...
    GSListTeamChatRequest* request = [[GSListTeamChatRequest alloc] init];
    [request setEntryCount:entryCount;
    [request setOffset:offset;
    [request setOwnerId:ownerId;
    [request setTeamId:teamId;
    [request setTeamType:teamType;
    [request setCallback:^ (GSListTeamChatResponse* response) {
    NSArray* messages = [response getMessages]; 
    NSDictionary* scriptData = [response getScriptData]; 
    }];
    [gs send:request];

C++


    #include <GameSparks/generated/GSRequests.h>
    using namespace GameSparks::Core;
    using namespace GameSparks::Api::Responses;
    using namespace GameSparks::Api::Requests;
    ...

    void ListTeamChatRequest_Response(GS& gsInstance, const ListTeamChatResponse& response) {
    gsstl:vector<Types::ChatMessage*> messages = response.getMessages(); 
    GSData scriptData = response.getScriptData(); 
    }
    ......

    ListTeamChatRequest request(gsInstance);
    request.SetEntryCount(entryCount)
    request.SetOffset(offset)
    request.SetOwnerId(ownerId)
    request.SetTeamId(teamId)
    request.SetTeamType(teamType)
    request.Send(ListTeamChatRequest_Response);

Java

import com.gamesparks.sdk.api.autogen.GSRequestBuilder.ListTeamChatRequest;
import com.gamesparks.sdk.api.autogen.GSResponseBuilder.ListTeamChatResponse;
import com.gamesparks.sdk.api.autogen.GSTypes.*;
import com.gamesparks.sdk.api.GSEventListener;

...
gs.getRequestBuilder().createListTeamChatRequest()
    .setEntryCount(entryCount)
    .setOffset(offset)
    .setOwnerId(ownerId)
    .setTeamId(teamId)
    .setTeamType(teamType)
    .send(new GSEventListener<ListTeamChatResponse>() {
        @Override
        public void onEvent(ListTeamChatResponse response) {
            List<ChatMessage> messages = response.getMessages(); 
        }
    });

Cloud Code


    var request = new SparkRequests.ListTeamChatRequest();
    request.entryCount = ...;
    request.offset = ...;
    request.ownerId = ...;
    request.teamId = ...;
    request.teamType = ...;
    var response = request.Send();

var messages = response.messages; 
var scriptData = response.scriptData;