plugin / com.github.shadowsocks.plugin / PluginContract

PluginContract

object PluginContract

The contract between the plugin provider and host. Contains definitions for the supported actions, extras, etc.

This class is written in Java to keep Java interoperability.

Properties

ACTION_CONFIGURE

const val ACTION_CONFIGURE: String

Activity Action: Used for ConfigurationActivity.

ACTION_HELP

const val ACTION_HELP: String

Activity Action: Used for HelpActivity or HelpCallback.

ACTION_NATIVE_PLUGIN

const val ACTION_NATIVE_PLUGIN: String

ContentProvider Action: Used for NativePluginProvider.

AUTHORITY

const val AUTHORITY: String

The authority for general plugin actions.

COLUMN_MODE

const val COLUMN_MODE: String

File mode bits. Default value is 644 in octal.

COLUMN_PATH

const val COLUMN_PATH: String

Relative to the file to be copied. This column is required.

EXTRA_ENTRY

const val EXTRA_ENTRY: String

The lookup key for a string that provides the plugin entry binary.

EXTRA_HELP_MESSAGE

const val EXTRA_HELP_MESSAGE: String

The lookup key for a CharSequence that provides user relevant help message.

EXTRA_OPTIONS

const val EXTRA_OPTIONS: String

The lookup key for a string that provides the options as a string.

METADATA_KEY_DEFAULT_CONFIG

const val METADATA_KEY_DEFAULT_CONFIG: String

The metadata key to retrieve default configuration. Default value is empty.

METADATA_KEY_EXECUTABLE_PATH

const val METADATA_KEY_EXECUTABLE_PATH: String

The metadata key to retrieve executable path to your native binary. This path should be relative to your application's nativeLibraryDir.

METADATA_KEY_ID

const val METADATA_KEY_ID: String

The metadata key to retrieve plugin id. Required for plugins.

METHOD_GET_EXECUTABLE

const val METHOD_GET_EXECUTABLE: String

RESULT_FALLBACK

const val RESULT_FALLBACK: Int

ConfigurationActivity result: fallback to manual edit mode.

SCHEME

const val SCHEME: String

The scheme for general plugin actions.