com.pubnub.api.java.v2.callbacks.handlers.OnChannelMetadataHandler Maven / Gradle / Ivy

Go to download
package com.pubnub.api.java.v2.callbacks.handlers;

import com.pubnub.api.java.models.consumer.objects_api.channel.PNChannelMetadataResult;

@FunctionalInterface
public interface OnChannelMetadataHandler {
    /**
     * 
     * This interface is designed for implementing custom handlers that respond to channelMetadata event retrieval operations.
     * It defines a single {@code handle} method that is called with a {@link PNChannelMetadataResult} instance,
     * which contains the channel metadata.
     * 
     * 
     * Usage example:
     * 
     *      * {@code
     * OnChannelMetadataHandler handler = pnChannelMetadataResult -> {
     *     System.out.println("Received channel metadata event: " + pnChannelMetadataResult.getEvent());
     * };
     * }
     * 
     *
     * @see PNChannelMetadataResult for more information about the channel metadata result provided to this handler.
     */
    void handle(PNChannelMetadataResult pnChannelMetadataResult);
}