SoroushMessage (Camel :: Soroush 3.11.1 API)

java.lang.Object
- org.apache.camel.component.soroushbot.models.SoroushMessage

All Implemented Interfaces:: Cloneable

public class SoroushMessage
extends Object
implements Cloneable

Constructor Summary

Constructors
Constructor and Description
`SoroushMessage()`
`SoroushMessage(String to, String from, String body, MinorType type, String time, String fileName, FileType fileType, Double fileSize, String fileUrl, String thumbnailUrl, Double imageWidth, Double imageHeight, Double fileDuration, Double thumbnailWidth, Double thumbnailHeight, String nickName, String avatarUrl, Double phoneNo, Double latitude, Double longitude, List<List<CustomKey>> keyboard)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SoroushMessage`	`clone()`
`boolean`	`equals(Object o)`
`String`	`getAvatarUrl()`
`String`	`getBody()`
`InputStream`	`getFile()`
`Double`	`getFileDuration()`
`String`	`getFileName()`
`Double`	`getFileSize()`
`FileType`	`getFileType()`
`String`	`getFileUrl()`
`String`	`getFrom()`
`Double`	`getImageHeight()`
`Double`	`getImageWidth()`
`List<List<CustomKey>>`	`getKeyboard()`
`Double`	`getLatitude()`
`Double`	`getLongitude()`
`String`	`getNickName()`
`Double`	`getPhoneNo()`
`InputStream`	`getThumbnail()`
`Double`	`getThumbnailHeight()`
`String`	`getThumbnailUrl()`
`Double`	`getThumbnailWidth()`
`String`	`getTime()`
`String`	`getTo()`
`MinorType`	`getType()`
`int`	`hashCode()`
`void`	`setAvatarUrl(String avatarUrl)`
`void`	`setBody(String body)`
`void`	`setFile(File file)` set uploading file to a file this field help you store file in the message, it also let you automatically upload it to the soroush server by sending this message to `uploadFile` or `sendMessage` endpoint.
`void`	`setFile(InputStream file)`
`void`	`setFileDuration(Double fileDuration)`
`void`	`setFileName(String fileName)`
`void`	`setFileSize(Double fileSize)`
`void`	`setFileType(FileType fileType)`
`void`	`setFileUrl(String fileUrl)`
`void`	`setFrom(String from)`
`void`	`setImageHeight(Double imageHeight)`
`void`	`setImageWidth(Double imageWidth)`
`void`	`setKeyboard(List<List<CustomKey>> keyboard)`
`void`	`setLatitude(Double latitude)`
`void`	`setLongitude(Double longitude)`
`void`	`setNickName(String nickName)`
`void`	`setPhoneNo(Double phoneNo)`
`void`	`setThumbnail(File thumbnail)` set uploading thumbnail to a `thumbnail` this field help you store thumbnail in the message, it also let you automatically upload it to the soroush server by sending this message to `uploadFile` or `sendMessage` endpoint.
`void`	`setThumbnail(InputStream thumbnail)`
`void`	`setThumbnailHeight(Double thumbnailHeight)`
`void`	`setThumbnailUrl(String thumbnailUrl)`
`void`	`setThumbnailWidth(Double thumbnailWidth)`
`void`	`setTime(String time)`
`void`	`setTo(String to)`
`void`	`setType(MinorType type)`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SoroushMessage
```
public SoroushMessage()
```

SoroushMessage

public SoroushMessage(String to,
                      String from,
                      String body,
                      MinorType type,
                      String time,
                      String fileName,
                      FileType fileType,
                      Double fileSize,
                      String fileUrl,
                      String thumbnailUrl,
                      Double imageWidth,
                      Double imageHeight,
                      Double fileDuration,
                      Double thumbnailWidth,
                      Double thumbnailHeight,
                      String nickName,
                      String avatarUrl,
                      Double phoneNo,
                      Double latitude,
                      Double longitude,
                      List<List<CustomKey>> keyboard)

Method Detail

setFile
```
public void setFile(File file)
             throws FileNotFoundException
```
set uploading file to a file this field help you store file in the message, it also let you automatically upload it to the soroush server by sending this message to uploadFile or sendMessage endpoint. auto upload file is working in the following condition: for sendMessage endpoint: file!=null && SoroushBotEndpoint.autoUploadFile && ( fileUrl==null || SoroushBotEndpoint.forceUpload) for uploadFile endpoint: file!=null && ( fileUrl==null || SoroushBotEndpoint.forceUpload)

Parameters:

file - to be uploaded

Throws:

FileNotFoundException - if file not found

See Also:

SoroushBotEndpoint.forceUpload, SoroushBotEndpoint.autoUploadFile

setThumbnail
```
public void setThumbnail(File thumbnail)
                  throws FileNotFoundException
```
set uploading thumbnail to a thumbnail this field help you store thumbnail in the message, it also let you automatically upload it to the soroush server by sending this message to uploadFile or sendMessage endpoint. auto upload thumbnail is working in the following condition: for sendMessage endpoint: thumbnail!=null && SoroushBotEndpoint.autoUploadFile && ( thumbnailUrl==null || SoroushBotEndpoint.forceUpload) for uploadFile endpoint: thumbnail!=null && ( thumbnailUrl==null || SoroushBotEndpoint.forceUpload)

Parameters:

thumbnail - to be uploaded

Throws:

FileNotFoundException - if file not found

See Also:

SoroushBotEndpoint.forceUpload, SoroushBotEndpoint.autoUploadFile

getTo
```
public String getTo()
```

setTo
```
public void setTo(String to)
```

getFrom
```
public String getFrom()
```

setFrom
```
public void setFrom(String from)
```

getBody
```
public String getBody()
```

setBody
```
public void setBody(String body)
```

getType
```
public MinorType getType()
```

setType
```
public void setType(MinorType type)
```

getTime
```
public String getTime()
```

setTime
```
public void setTime(String time)
```

getFileName
```
public String getFileName()
```

setFileName

public void setFileName(String fileName)

getFileType
```
public FileType getFileType()
```

setFileType

public void setFileType(FileType fileType)

getFileSize
```
public Double getFileSize()
```

setFileSize

public void setFileSize(Double fileSize)

getFileUrl
```
public String getFileUrl()
```

setFileUrl

public void setFileUrl(String fileUrl)

getThumbnailUrl
```
public String getThumbnailUrl()
```

setThumbnailUrl

public void setThumbnailUrl(String thumbnailUrl)

getImageWidth
```
public Double getImageWidth()
```

setImageWidth

public void setImageWidth(Double imageWidth)

getImageHeight
```
public Double getImageHeight()
```

setImageHeight

public void setImageHeight(Double imageHeight)

getFileDuration
```
public Double getFileDuration()
```

setFileDuration

public void setFileDuration(Double fileDuration)

getThumbnailWidth
```
public Double getThumbnailWidth()
```

setThumbnailWidth

public void setThumbnailWidth(Double thumbnailWidth)

getThumbnailHeight
```
public Double getThumbnailHeight()
```

setThumbnailHeight

public void setThumbnailHeight(Double thumbnailHeight)

getNickName
```
public String getNickName()
```

setNickName

public void setNickName(String nickName)

getAvatarUrl
```
public String getAvatarUrl()
```

setAvatarUrl

public void setAvatarUrl(String avatarUrl)

getPhoneNo
```
public Double getPhoneNo()
```

setPhoneNo

public void setPhoneNo(Double phoneNo)

getLatitude
```
public Double getLatitude()
```

setLatitude

public void setLatitude(Double latitude)

getLongitude
```
public Double getLongitude()
```

setLongitude

public void setLongitude(Double longitude)

getKeyboard

public List<List<CustomKey>> getKeyboard()

setKeyboard

public void setKeyboard(List<List<CustomKey>> keyboard)

getFile
```
public InputStream getFile()
```

setFile

public void setFile(InputStream file)

getThumbnail
```
public InputStream getThumbnail()
```

setThumbnail

public void setThumbnail(InputStream thumbnail)

toString
```
public String toString()
```
Overrides:

toString in class Object

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

clone

public SoroushMessage clone()
                     throws CloneNotSupportedException

Overrides:: clone in class Object
Throws:: CloneNotSupportedException

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

Class SoroushMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SoroushMessage

SoroushMessage

Method Detail

setFile

setThumbnail

getTo

setTo

getFrom

setFrom

getBody

setBody

getType

setType

getTime

setTime

getFileName

setFileName

getFileType

setFileType

getFileSize

setFileSize

getFileUrl

setFileUrl

getThumbnailUrl

setThumbnailUrl

getImageWidth

setImageWidth

getImageHeight

setImageHeight

getFileDuration

setFileDuration

getThumbnailWidth

setThumbnailWidth

getThumbnailHeight

setThumbnailHeight

getNickName

setNickName

getAvatarUrl

setAvatarUrl

getPhoneNo

setPhoneNo

getLatitude

setLatitude

getLongitude

setLongitude

getKeyboard

setKeyboard

getFile

setFile

getThumbnail

setThumbnail

toString

equals

clone

hashCode