Paginación con Vonage Client SDK

Product deprecation notice

Effective April 30th, 2026, Vonage In-App Messaging will no longer be available. Access for new users will be closed, and the service will be discontinued for all existing users.

If you have any questions regarding this product’s discontinuation, please contact your account manager or our support team.

Al obtener una lista de objetos con el Vonage Client SDK, la respuesta será paginada. Esto significa que en lugar de devolver todos los objetos a la vez, lo cual aumentaría la latencia y el tamaño de la respuesta, obtendrás un fragmento de la respuesta o un fragmento de la respuesta. página. Por ejemplo, llamar a getConversations devolverá un ConversationsPage.

Las funciones que devuelven una página, tendrán parámetros para un tamaño de página, y un cursor. Suministrando un cursor puede recorrer las páginas hasta obtener todos los resultados. Aquí hay un ejemplo con la obtención de Conversaciones.

let conversations, nextCursor, previousCursor
const params = {
    order: "asc", // "desc"
    pageSize: 5,
    cursor: null,
    includeCustomData: true,
    orderBy: null // "CUSTOM_SORT_KEY"     
};

client.getConversations(params)
    .then(conversationsPage => {
        ({conversations, nextCursor, previousCursor} = conversationsPage);
        console.log("Array of Conversations: ", conversations);
        console.log("Cursor for next set of results, if any. Could be null: ", nextCursor);
        console.log("Cursor for previous set of results, if any. Could be null: ", previousCursor);
    }).catch(error => {
        console.error("Error getting Conversations: ", error);
    });

val params = GetConversationsParameters(order = PresentingOrder.ASC, pageSize = 5, cursor = null)
client.getConversations(params) { error, conversationsPage ->
    error?.let { /* Handle Error in fetching Conversations */ }
    conversationsPage?.let {
        val nextCursor = it.nextCursor
        val previousCursor = it.previousCursor
        it.conversations.forEach {conversation ->
            println("Conversation id: ${conversation.id}, name: ${conversation.name}")
        }
    }
}

let params = VGGetConversationsParameters(order: .asc, pageSize: 5, cursor: nil)
client.getConversations(params) { error, conversationsPage in 
    if error == nil {
        let conversations = conversationsPage!.conversations
        let nextCursor = conversationsPage!.nextCursor
        let previousCursor = conversationsPage!.previousCursor
    } else {
        // Handle failure
    }
}

En el ConversationsPage hay un nextCursor y previousCursor parámetro. Para obtener la siguiente página de Conversaciones, llame a getConversations de nuevo, pero esta vez proporciona el valor de la actual ConversationsPage.nextCursor para el cursor:

const params = {
    order: "asc", // "desc"
    pageSize: 5,
    cursor: nextCursor, // previousCursor
    includeCustomData: true,
    orderBy: null // "CUSTOM_SORT_KEY"     
};

client.getConversations(params)
    ...

val params = GetConversationsParameters(order = PresentingOrder.ASC, pageSize = 5, cursor = nextCursor)
client.getConversations(params) { error, conversationsPage ->
    error?.let { /* Handle Error in fetching Conversations */ }
    conversationsPage?.let {
        it.conversations.forEach {conversation ->
            println("Conversation id: ${conversation.id}, name: ${conversation.name}")
        }
    }
}

let params = VGGetConversationsParameters(order: .asc, pageSize: 5, cursor: nextCursor)
client.getConversations(params) { error, conversationsPage in 
    ...
}

Cuando llegues al final de los resultados, nextCursor será nulo/nulo. Inversamente, al llegar al inicio de los resultados previousCursor será nulo/nulo.