Protocol (common-api 0.9.0 API)

java.lang.Object
- io.github.ma1uta.matrix.protocol.Protocol

```
public class Protocol
extends Object
```
Protocol metadata.

Field Summary

Fields
Modifier and Type	Field	Description
`private Map<String,FieldMetadata>`	`fieldTypes`	Required.
`private String`	`icon`	Required.
`private List<Instance>`	`instances`	Required.
`private List<String>`	`locationFields`	Required.
`private List<String>`	`userFields`	Required.

Constructor Summary

Constructors
Constructor Description

Protocol()

Method Summary

Modifier and Type	Method	Description
`Map<String,FieldMetadata>`	`getFieldTypes()`
`String`	`getIcon()`
`List<Instance>`	`getInstances()`
`List<String>`	`getLocationFields()`
`List<String>`	`getUserFields()`
`void`	`setFieldTypes(Map<String,FieldMetadata> fieldTypes)`
`void`	`setIcon(String icon)`
`void`	`setInstances(List<Instance> instances)`
`void`	`setLocationFields(List<String> locationFields)`
`void`	`setUserFields(List<String> userFields)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- userFields
```
private List<String> userFields
```
  Required. Fields used to identify a third party user.
- locationFields
```
private List<String> locationFields
```
  Required. Fields used to identify a third party location.
- icon
```
private String icon
```
  Required. An icon representing the third party protocol.
- fieldTypes
```
private Map<String,FieldMetadata> fieldTypes
```
  Required. All location or user fields should have an entry here.
- instances
```
private List<Instance> instances
```
  Required. A list of objects representing independent instances of configuration. For instance multiple networks on IRC if multiple are bridged by the same bridge.

Constructor Detail
- Protocol
```
public Protocol()
```

Method Detail

getUserFields
```
public List<String> getUserFields()
```

setUserFields

public void setUserFields(List<String> userFields)

getLocationFields

public List<String> getLocationFields()

setLocationFields

public void setLocationFields(List<String> locationFields)

getIcon
```
public String getIcon()
```

setIcon
```
public void setIcon(String icon)
```

getFieldTypes

public Map<String,FieldMetadata> getFieldTypes()

setFieldTypes

public void setFieldTypes(Map<String,FieldMetadata> fieldTypes)

getInstances
```
public List<Instance> getInstances()
```

setInstances

public void setInstances(List<Instance> instances)