Spreadsheet

Abstract Value Members

abstract def accessToken: String

OAuth access token
implicit abstract def context: ExecutionContext

Execution context
abstract def refreshToken: Option[RefreshToken]

Can be used with offline access token, to refresh it.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def append(spreadsheetId: String, worksheetId: String, values: String*): Future[List[URI]]

Inserts given values as uninterrupted sequence of cells in a new row at end of the specified worksheet.
Inserts given values as uninterrupted sequence of cells in a new row at end of the specified worksheet.
spreadsheetId
Spreadsheet ID (SpreadsheetInfo.id)
worksheetId
Worksheet ID (SpreadsheetInfo.id)
values
Uninterrupted sequence of cell values
def append(spreadsheetId: String, worksheetId: String, values: List[(Int, String)]): Future[List[URI]]

Inserts given values as cells in a new row at end of the specified worksheet (after the last row containing a cell with some content).
Inserts given values as cells in a new row at end of the specified worksheet (after the last row containing a cell with some content).
spreadsheetId
Spreadsheet ID (SpreadsheetInfo.id)
worksheetId
Worksheet ID (SpreadsheetInfo.id)
values
Cell values with associated positions (first = 1)
final def asInstanceOf[T0]: T0

Definition Classes
Any
def cells(spreadsheetId: String, worksheetId: String, rowRange: Option[WorksheetRange], colRange: Option[WorksheetRange]): Future[Option[WorksheetCells]]

Returns matching cells, if any.
Returns matching cells, if any.
spreadsheetId
Spreadsheet ID (SpreadsheetInfo.id)
worksheetId
Worksheet ID (WorksheetInfo.id)
rowRange
Optional row range
colRange
Optional column range
```
cells("spreadsheetId", "worksheetId", None, None)
```
def cells(id: String, index: Int, rowRange: Option[WorksheetRange], colRange: Option[WorksheetRange]): Future[Option[WorksheetCells]]

Returns matching cells, if any.
Returns matching cells, if any.
id
Spreadsheet ID
index
Worksheet index (first = 0)
rowRange
Optional row range
colRange
Optional column range
```
cells("spreadsheetId", 0, None, None) // all cells of first worksheet
```
def cells(uri: URI, rowRange: Option[WorksheetRange], colRange: Option[WorksheetRange]): Future[Option[WorksheetCells]]

Returns list of cells from given URI (WorksheetInfo.cellsUri).
Returns list of cells from given URI (WorksheetInfo.cellsUri).
uri
Cells URI
rowRange
Row range
colRange
Column range
def change(spreadsheetId: String, worksheetId: String, cells: List[CellValue]): Future[List[URI]]

Changes cell in specified worksheet.
Changes cell in specified worksheet.
spreadsheetId
Spreadsheet ID (SpreadsheetInfo.id)
worksheetId
Worksheet ID (WorksheetInfo.id)
cells
List of cells to be created
returns
List of version URIs for each created cell
```
// Put "A" as content of cell at first row second column,
// first worksheet of specified spreadsheet
change("spreadsheetId", "worksheetId", List(CellValue(1, 2, "A")))
```
def change(id: String, index: Int, cells: List[CellValue]): Future[List[URI]]

Changes cell in specified worksheet.
Changes cell in specified worksheet.
id
Spreadsheet ID
index
Worksheet index (first = 0)
cells
List of cells to be created
returns
List of version URIs for each created cell
```
// Put "A" as content of cell at first row second column,
// first worksheet of specified spreadsheet
change("spreadsheetId", 0, List(CellValue(1, 2, "A")))
```
def change(uri: URI, cells: List[CellValue]): Future[List[URI]]

Changes cells.
Changes cells. Any existing content will be overwrited .
uri
Cells URI (WorksheetInfo.cellsUri)
cells
List of cells to be created
returns
List of version URI for each created cell
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def lastRow(spreadsheetId: String, worksheetId: String): Future[Option[WorksheetCells]]

Returns last row of specified worksheet, if any.
Returns last row of specified worksheet, if any.
spreadsheetId
Spreadsheet ID (SpreadsheetInfo.id)
worksheetId
Worksheet ID (WorksheetInfo.id)
```
lastRow("spreadsheetId", "worksheetId")
```
def list: Future[List[SpreadsheetInfo]]

Returns list of all available spreadsheets.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def spreadsheet(id: String): Future[SpreadsheetInfo]

Returns information for matching spreadsheet, if any.
Returns information for matching spreadsheet, if any.
id
Spreadsheet ID (SpreadsheetInfo.id)
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withWorksheets[T](id: String)(z: T)(f: (T, WorksheetInfo) ⇒ Either[T, T]): Future[T]

Processes worksheets found for specified spreadsheet (SpreadsheetInfo.worksheetsUri).
Processes worksheets found for specified spreadsheet (SpreadsheetInfo.worksheetsUri).
id
Spreadsheet ID
z
Initial value for function f
f
Function given current state and extracted information. Must return either a final value at Left if must not look at other worksheets, or updated value at Right to go on processing worksheets.
```
// api: Spreadsheet

// Will find the second worksheet...
val second: Future[Option[WorksheetInfo]] =
  api.worksheet("spreadsheetId")(1 -> None) { (st, w) =>
  val (i, _) = st
  if (i == 2) /* found some, so no next step */ Left(2 -> Some(w))
  else Right(i+1 -> None)
} map (_._2)
```
def worksheet(spreadsheetId: String, worksheetId: String): Future[Option[WorksheetInfo]]

Returns worksheet matching given ID.
Returns worksheet matching given ID.
spreadsheetId
Spreadsheet ID (SpreadsheetInfo.id)
worksheetId
Worksheet ID (WorksheetInfo.id)

See also
withWorksheets
def worksheet(id: String, index: Int): Future[Option[WorksheetInfo]]

Returns worksheet from specified worksheet whose index in feed is given one, if any.
Returns worksheet from specified worksheet whose index in feed is given one, if any.
id
Spreadsheet ID (SpreadsheetInfo.id)
index
Worksheet index in underlying feed (first = 0)
See also
withWorksheets
val first: Future[Option[WorksheetInfo]] = worksheet("spreadsheetId", 0)
def worksheets(uri: URI): Future[List[WorksheetInfo]]

Returns list of worksheets from given URI (SpreadsheetInfo.worksheetsUri).
def worksheets(id: String): Future[List[WorksheetInfo]]

Returns list of worksheets for specified spreadsheet
Returns list of worksheets for specified spreadsheet
id
Spreadsheet ID (SpreadsheetInfo.id)

trait Spreadsheet extends AnyRef

Abstract Value Members

abstract def accessToken: String

implicit abstract def context: ExecutionContext

abstract def refreshToken: Option[RefreshToken]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def append(spreadsheetId: String, worksheetId: String, values: String*): Future[List[URI]]

def append(spreadsheetId: String, worksheetId: String, values: List[(Int, String)]): Future[List[URI]]

final def asInstanceOf[T0]: T0

def cells(spreadsheetId: String, worksheetId: String, rowRange: Option[WorksheetRange], colRange: Option[WorksheetRange]): Future[Option[WorksheetCells]]

def cells(id: String, index: Int, rowRange: Option[WorksheetRange], colRange: Option[WorksheetRange]): Future[Option[WorksheetCells]]

def cells(uri: URI, rowRange: Option[WorksheetRange], colRange: Option[WorksheetRange]): Future[Option[WorksheetCells]]

def change(spreadsheetId: String, worksheetId: String, cells: List[CellValue]): Future[List[URI]]

def change(id: String, index: Int, cells: List[CellValue]): Future[List[URI]]

def change(uri: URI, cells: List[CellValue]): Future[List[URI]]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def lastRow(spreadsheetId: String, worksheetId: String): Future[Option[WorksheetCells]]

def list: Future[List[SpreadsheetInfo]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def spreadsheet(id: String): Future[SpreadsheetInfo]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withWorksheets[T](id: String)(z: T)(f: (T, WorksheetInfo) ⇒ Either[T, T]): Future[T]

def worksheet(spreadsheetId: String, worksheetId: String): Future[Option[WorksheetInfo]]

def worksheet(id: String, index: Int): Future[Option[WorksheetInfo]]

def worksheets(uri: URI): Future[List[WorksheetInfo]]

def worksheets(id: String): Future[List[WorksheetInfo]]

Inherited from AnyRef

Inherited from Any

Ungrouped