main.java.com.streamlayer.sdkSettings.common.SdkOverlayOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sl-protofiles Show documentation
StreamLayer Java Protofiles
There is a newer version: 5.133.1
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: streamlayer/sdkSettings/sdkSettings.common.proto

// Protobuf Java Version: 3.25.3
package com.streamlayer.sdkSettings.common;

public interface SdkOverlayOrBuilder extends
    // @@protoc_insertion_point(interface_extends:streamlayer.sdkSettings.SdkOverlay)
    com.google.protobuf.MessageLiteOrBuilder {

  /**
   *    * type for identify overlay
   * 
   *
   * .streamlayer.sdkSettings.SdkOverlayType type = 1 [json_name = "type"];
   * @return The enum numeric value on the wire for type.
   */
  int getTypeValue();
  /**
   *    * type for identify overlay
   * 
   *
   * .streamlayer.sdkSettings.SdkOverlayType type = 1 [json_name = "type"];
   * @return The type.
   */
  com.streamlayer.sdkSettings.common.SdkOverlayType getType();

  /**
   *    * button position in menu
   * 
   *
   * int32 position = 3 [json_name = "position"];
   * @return The position.
   */
  int getPosition();

  /**
   *    * flag to merge/overwrite stream and organization settings, cannot be used for update value
   * 
   *
   * bool overwrite = 4 [json_name = "overwrite"];
   * @return The overwrite.
   */
  boolean getOverwrite();

  /**
   *    * custom overlay settings
   * 
   *
   * .streamlayer.sdkSettings.SdkOverlaySettings settings = 5 [json_name = "settings"];
   * @return Whether the settings field is set.
   */
  boolean hasSettings();
  /**
   *    * custom overlay settings
   * 
   *
   * .streamlayer.sdkSettings.SdkOverlaySettings settings = 5 [json_name = "settings"];
   * @return The settings.
   */
  com.streamlayer.sdkSettings.common.SdkOverlaySettings getSettings();

  /**
   *    * custom overlay settings by levels. For streams only.
   * 
   *
   * .streamlayer.sdkSettings.SdkOverlayMeta meta = 6 [json_name = "meta"];
   * @return Whether the meta field is set.
   */
  boolean hasMeta();
  /**
   *    * custom overlay settings by levels. For streams only.
   * 
   *
   * .streamlayer.sdkSettings.SdkOverlayMeta meta = 6 [json_name = "meta"];
   * @return The meta.
   */
  com.streamlayer.sdkSettings.common.SdkOverlayMeta getMeta();

  /**
   *    * visible flag for organization, cannot be used for update value
   * 
   *
   * bool enable = 7 [json_name = "enable"];
   * @return The enable.
   */
  boolean getEnable();

  /**
   *    * visible flag for sdk clients, cannot be used for update value
   * 
   *
   * bool sdk_enable = 8 [json_name = "sdkEnable"];
   * @return The sdkEnable.
   */
  boolean getSdkEnable();

  /**
   *    * overlay name
   * 
   *
   * string name = 9 [json_name = "name"];
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * overlay name
   * 
   *
   * string name = 9 [json_name = "name"];
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * overlay icon, if not present use default by overlay type
   * 
   *
   * string icon = 10 [json_name = "icon"];
   * @return The icon.
   */
  java.lang.String getIcon();
  /**
   *    * overlay icon, if not present use default by overlay type
   * 
   *
   * string icon = 10 [json_name = "icon"];
   * @return The bytes for icon.
   */
  com.google.protobuf.ByteString
      getIconBytes();

  /**
   *    * svg overlay icon, if not present use default by overlay type
   * 
   *
   * string svg_icon = 11 [json_name = "svgIcon"];
   * @return The svgIcon.
   */
  java.lang.String getSvgIcon();
  /**
   *    * svg overlay icon, if not present use default by overlay type
   * 
   *
   * string svg_icon = 11 [json_name = "svgIcon"];
   * @return The bytes for svgIcon.
   */
  com.google.protobuf.ByteString
      getSvgIconBytes();

  /**
   * string enable_overwrite = 12 [json_name = "enableOverwrite"];
   * @return Whether the enableOverwrite field is set.
   */
  boolean hasEnableOverwrite();
  /**
   * string enable_overwrite = 12 [json_name = "enableOverwrite"];
   * @return The enableOverwrite.
   */
  java.lang.String getEnableOverwrite();
  /**
   * string enable_overwrite = 12 [json_name = "enableOverwrite"];
   * @return The bytes for enableOverwrite.
   */
  com.google.protobuf.ByteString
      getEnableOverwriteBytes();

  /**
   * string disable_overwrite = 13 [json_name = "disableOverwrite"];
   * @return Whether the disableOverwrite field is set.
   */
  boolean hasDisableOverwrite();
  /**
   * string disable_overwrite = 13 [json_name = "disableOverwrite"];
   * @return The disableOverwrite.
   */
  java.lang.String getDisableOverwrite();
  /**
   * string disable_overwrite = 13 [json_name = "disableOverwrite"];
   * @return The bytes for disableOverwrite.
   */
  com.google.protobuf.ByteString
      getDisableOverwriteBytes();

  /**
   *    * button visible flag in SDK menu, cannot be used for update value
   * 
   *
   * bool enable_sdk_button = 14 [json_name = "enableSdkButton"];
   * @return The enableSdkButton.
   */
  boolean getEnableSdkButton();

  public com.streamlayer.sdkSettings.common.SdkOverlay.OverwriteFlagCase getOverwriteFlagCase();
}