Annotation Type InternalSdk


  • public @interface InternalSdk
    Annotation to indicate a class or method is only meant for internal SDK usage, and may break/change without notice.

    Classes or methods with this annotation generally appear in non-'internal' packages so that they show up for documentation but are not intended to for consumers to actually use.

    Note, by convention, any class with 'internal' in the package name is not intended for consumers to directly use, regardless of whether or not it contains this annotation.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean backwardCompatibilityRequired
      If set to true, backward compatibility should be maintained, even though this is internal SDK code.
    • Element Detail

      • backwardCompatibilityRequired

        boolean backwardCompatibilityRequired
        If set to true, backward compatibility should be maintained, even though this is internal SDK code.
        Returns:
        true if backward compatibility should be maintained
        Default:
        false