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

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

import com.pubnub.api.java.models.consumer.objects_api.membership.PNMembershipResult;

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