com.echobox.api.tiktok.model.HasCursor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebx-tiktok-sdk Show documentation

ebx-tiktok-sdk is a pure Java TikTok API client. It implements the v1.3 API.

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.echobox.api.tiktok.model;

import java.util.List;

/**
 * Interface for response objects that have a cursor, meaning that the data can be listed in pages
 *
 * @param   the data type
 * @author eddspencer
 */
public interface HasCursor {
  
  /**
   * Checks if there is more data in the cursor
   *
   * @return Whether an additional page of data is available.
   */
  boolean hasMore();
  
  /**
   * Get the cursor pointer for subsequent requests, the cursor is unix time in milliseconds
   *
   * @return Cursor for the next page of results, to be passed in the cursor query parameter of
   * the subsequent API request.
   */
  Long getCursor();
  
  /**
   * Return the data in the request
   *
   * @return the data returned in the page
   */
  List getData();
}