Protection

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. def addEditor(user: User): Protection

   

   Adds the given user to the list of editors for the protected sheet or range.

   Adds the given user to the list of editors for the protected sheet or range. This method does not automatically give the user permission to edit the spreadsheet itself; to do that in addition, call Spreadsheet.addEditor(user).

5. def addEditor(emailAddress: String): Protection

   

   Adds the given user to the list of editors for the protected sheet or range.

   Adds the given user to the list of editors for the protected sheet or range. This method does not automatically give the user permission to edit the spreadsheet itself; to do that in addition, call Spreadsheet.addEditor(emailAddress).

6. def addEditors(emailAddresses: Array[String]): Protection

   

   Adds the given array of users to the list of editors for the protected sheet or range.

   Adds the given array of users to the list of editors for the protected sheet or range. This method does not automatically give the users permission to edit the spreadsheet itself; to do that in addition, call Spreadsheet.addEditors(emailAddresses).

7. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

8. def canDomainEdit(): Boolean

   

   Determines whether all users in the domain that owns the spreadsheet have permission to edit the protected range or sheet.

   Determines whether all users in the domain that owns the spreadsheet have permission to edit the protected range or sheet. Throws an exception if the user does not have permission to edit the protected range or sheet.

9. def canEdit(): Boolean

   

   Determines whether the user has permission to edit the protected range or sheet.

   Determines whether the user has permission to edit the protected range or sheet. The spreadsheet owner is always able to edit protected ranges and sheets.

10. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

11. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

12. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

13. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

14. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

15. def getDescription(): String

    

    Gets the description of the protected range or sheet.

    Gets the description of the protected range or sheet. If no description is set, this method returns an empty string.

16. def getEditors(): Array[User]

    

    Gets the list of editors for the protected range or sheet.

    Gets the list of editors for the protected range or sheet. Throws an exception if the user does not have permission to edit the protected range or sheet.

17. def getProtectionType(): ProtectionType

    

    Gets the type of the protected area, either SpreadsheetApp.ProtectionType.RANGE or SpreadsheetApp.ProtectionType.SHEET.

18. def getRange(): Range

    

    Gets the range that is being protected.

    Gets the range that is being protected. If the protection applies to the sheet instead of a range, this method returns a range that spans the entire sheet.

19. def getRangeName(): String

    

    Gets the name of the protected range if it is associated with a named range.

    Gets the name of the protected range if it is associated with a named range. Returns null if the protection is not associated with a named range. Note that scripts must explicitly call setRangeName(rangeName) to associate a protected range with a named range; calling Range.protect() to create a protection from a Range that happens to be a named range, without calling setRangeName(rangeName), is not sufficient to associate them. However, creating a protected range from a named range in the Google Sheets UI will associate them automatically.

20. def getUnprotectedRanges(): Array[Range]

    

    Gets an array of unprotected ranges within a protected sheet.

    Gets an array of unprotected ranges within a protected sheet. If the Protection object corresponds to a protected range instead of a protected sheet, this method returns an empty array. To change the unprotected ranges, use setUnprotectedRanges(ranges) to set a new array of ranges; to re-protect the entire sheet, set an empty array.

21. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

22. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

23. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

24. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

25. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

26. final def notify(): Unit

    

    Definition Classes

    AnyRef

27. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

28. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

29. def remove(): Unit

    

    Unprotects the range or sheet.

30. def removeEditor(user: User): Protection

    

    Removes the given user from the list of editors for the protected sheet or range.

    Removes the given user from the list of editors for the protected sheet or range. Note that if the user is a member of a Google Group that has edit permission, or if all users in the domain have edit permission, the user will still be able to edit the protected area as well. Neither the owner of the spreadsheet nor the current user can be removed.

31. def removeEditor(emailAddress: String): Protection

    

    Removes the given user from the list of editors for the protected sheet or range.

    Removes the given user from the list of editors for the protected sheet or range. Note that if the user is a member of a Google Group that has edit permission, or if all users in the domain have edit permission, the user will still be able to edit the protected area. Neither the owner of the spreadsheet nor the current user can be removed.

32. def removeEditors(emailAddresses: Array[String]): Protection

    

    Removes the given array of users from the list of editors for the protected sheet or range.

    Removes the given array of users from the list of editors for the protected sheet or range. Note that if any of the users are members of a Google Group that has edit permission, or if all users in the domain have edit permission, those users will still be able to edit the protected area. Neither the owner of the spreadsheet nor the current user can be removed.

33. def setDescription(description: String): Protection

    

    Sets the description of the protected range or sheet.

34. def setDomainEdit(editable: Boolean): Protection

    

    Sets whether all users in the domain that owns the spreadsheet have permission to edit the protected range or sheet.

    Sets whether all users in the domain that owns the spreadsheet have permission to edit the protected range or sheet. Note that any users who have explicit edit permission will be able to edit the protected area regardless of this setting. Throws an exception if the spreadsheet does not belong to a Google Apps domain (that is, if it is owned by a gmail.com account).

35. def setRange(range: Range): Protection

    

    Adjusts the range that is being protected.

    Adjusts the range that is being protected. If the given range covers a different area from the current protected range, this method moves the protection to cover the new range instead.

36. def setRangeName(rangeName: String): Protection

    

    Associates the protected range with an existing named range.

    Associates the protected range with an existing named range. If the named range covers a different area from the current protected range, this method moves the protection to cover the the named range instead. The named range must be on the same sheet as the current protected range. Note that scripts must explicitly call this method to associate a protected range with a named range; calling Range.protect() to create a protection from a Range that happens to be a named range, without calling setRangeName(rangeName), is not sufficient to associate them. However, creating a protected range from a named range in the Google Sheets UI will associate them automatically.

37. def setUnprotectedRanges(ranges: Array[Range]): Protection

    

    Unprotects the given array of ranges within a protected sheet.

    Unprotects the given array of ranges within a protected sheet. Throws an exception if the Protection object corresponds to a protected range instead of a protected sheet or if any of the ranges are not on the protected sheet. To change the unprotected ranges, set a new array of ranges; to re-protect the entire sheet, set an empty array.

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

    

    Definition Classes

    AnyRef

39. def toLocaleString(): String

    

    Definition Classes

    Object

40. def toString(): String

    

    Definition Classes

    AnyRef → Any

41. def valueOf(): Any

    

    Definition Classes

    Object

42. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

44. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )